Packages

phoenix_kit

1.7.75
1.7.208 1.7.207 1.7.206 1.7.205 1.7.204 1.7.203 1.7.202 1.7.201 1.7.200 1.7.199 1.7.198 1.7.197 1.7.196 1.7.194 1.7.193 1.7.192 1.7.191 1.7.190 1.7.189 1.7.187 1.7.186 1.7.185 1.7.184 1.7.183 1.7.182 1.7.181 1.7.180 1.7.179 1.7.178 1.7.177 1.7.176 1.7.175 1.7.174 1.7.173 1.7.172 1.7.171 1.7.170 1.7.169 1.7.168 1.7.167 1.7.166 1.7.165 1.7.164 1.7.162 1.7.161 1.7.160 1.7.159 1.7.157 1.7.156 1.7.155 1.7.154 1.7.153 1.7.152 1.7.151 1.7.150 1.7.149 1.7.146 1.7.145 1.7.144 1.7.143 1.7.138 1.7.133 1.7.132 1.7.131 1.7.130 1.7.128 1.7.126 1.7.125 1.7.121 1.7.120 1.7.119 1.7.118 1.7.117 1.7.116 1.7.115 1.7.114 1.7.113 1.7.112 1.7.111 1.7.110 1.7.109 1.7.108 1.7.107 1.7.106 1.7.105 1.7.104 1.7.103 1.7.102 1.7.101 1.7.100 1.7.99 1.7.98 1.7.97 1.7.96 1.7.95 1.7.94 1.7.93 1.7.92 1.7.91 1.7.90 1.7.89 1.7.88 1.7.87 1.7.86 1.7.85 1.7.84 1.7.83 1.7.82 1.7.81 1.7.80 1.7.79 1.7.78 1.7.77 1.7.76 1.7.75 1.7.74 1.7.71 1.7.70 1.7.69 1.7.66 1.7.65 1.7.64 1.7.63 1.7.62 1.7.61 1.7.59 1.7.58 1.7.57 1.7.56 1.7.55 1.7.54 1.7.53 1.7.52 1.7.51 1.7.49 1.7.44 1.7.43 1.7.42 1.7.41 1.7.39 1.7.38 1.7.37 1.7.36 1.7.34 1.7.33 1.7.31 1.7.30 1.7.29 1.7.28 1.7.27 1.7.26 1.7.25 1.7.24 1.7.23 1.7.22 1.7.21 1.7.20 1.7.19 1.7.18 1.7.17 1.7.16 1.7.15 1.7.14 1.7.13 1.7.12 1.7.11 1.7.10 1.7.9 1.7.8 1.7.7 1.7.6 1.7.5 1.7.4 1.7.3 1.7.2 1.7.1 1.7.0 1.6.20 1.6.19 1.6.18 1.6.17 1.6.16 1.6.15 1.6.14 1.6.13 1.6.12 1.6.11 1.6.10 1.6.9 1.6.8 1.6.7 1.6.6 1.6.5 1.6.4 1.6.3 1.5.2 1.5.1 1.5.0 1.4.9 1.4.8 1.4.7 1.4.6 1.4.5 1.4.4 1.4.3 1.4.2 1.4.1 1.4.0 1.3.2 1.3.1 1.3.0 1.2.10 1.2.9 1.2.8 1.2.7 1.2.5 1.2.4 1.2.2 1.2.1 1.2.0 1.1.0 1.0.0

A foundation for building Elixir Phoenix apps — SaaS, social networks, ERP systems, marketplaces, and more

HexDocs

Current section

Files

Jump to
Readme
222 Versions
39 Dependencies
Dependants
Files
Activity
phoenix_kit lib modules entities README.md
Raw

lib/modules/entities/README.md 

# Entities Module



The Entities module delivers PhoenixKit's dynamic content type system. It allows administrators

to design structured content types with custom fields without writing migrations or code. This README gives a quick orientation for contributors working on the LiveView

layer; the business logic lives in the `PhoenixKit.Modules.Entities` context.



## LiveViews & Components



- `entities.ex` / `.html.heex` – Main dashboard listing entities with table/card views (card view auto-selected on small screens).

- `entity_form.ex` / `.html.heex` – Schema builder for creating and editing entity definitions (with presence locking).

- `entities_settings.ex` / `.html.heex` – Module settings (enable/disable system, defaults).

- `data_navigator.ex` / `.html.heex` – Explorer for entity records with filtering, search, and status management.

- `data_form.ex` / `.html.heex` – Dynamic form renderer for entity entries (with presence locking).

- `hooks.ex` – LiveView hooks (presence, authorization guards, shared assigns).



All templates follow Phoenix 1.8 layout conventions (`<Layouts.app ...>` with `@current_scope`).



## Feature Highlights



- **Entity Designer** – Build custom fields, validations, and display ordering for each entity type.

- **JSONB Storage** – Field definitions stored as JSONB, no database migrations needed for schema changes.

- **Multi-Language Support** – Language tabs in forms, override-only storage for secondary languages, lazy re-keying on primary language change. Driven globally by the Languages module.

- **Language-Aware API** – All list/get functions accept an optional `lang:` option to return translated fields resolved for a specific language.

- **Record Ordering** – Per-entity sort mode (auto by creation date or manual by position). Manual mode supports drag-and-drop reordering via the `position` column (V81 migration).

- **Data Navigator** – Browse, search, and filter entity data with status filters and archive/restore workflow.

- **Collaborative Editing** – Presence helpers in entity_form and data_form prevent overwrites when multiple admins edit the same record.

- **Settings Guardrails** – Module can be toggled on/off via PhoenixKit Settings (`entities_enabled`).

- **Event Broadcasting** – Hooks integrate with `PhoenixKit.Modules.Entities.Events` for lifecycle tracking.



## Integration Points



- Context modules: `PhoenixKit.Modules.Entities`, `PhoenixKit.Modules.Entities.EntityData`, `PhoenixKit.Modules.Entities.FieldTypes`.

- Multilang module: `PhoenixKit.Modules.Entities.Multilang` – pure-function helpers for multilang JSONB.

- Supporting modules: `PhoenixKit.Modules.Entities.Events`, `PhoenixKit.Modules.Entities.PresenceHelpers`.

- Languages integration: multilang is auto-enabled when `PhoenixKit.Modules.Languages` has 2+ enabled languages.

- Enabling flag: `PhoenixKit.Settings.get_setting("entities_enabled", "false")`.

- Router: available under `{prefix}/admin/entities/*` via `phoenix_kit_routes()`.



## Customizing the Data View



The admin route `/admin/entities/:entity_slug/data/:id` is handled by

`PhoenixKit.Modules.Entities.Web.DataView`. To replace it with your own LiveView,

declare a route at the same path **before** `phoenix_kit_routes()` in your router:



```elixir

# In your app's router.ex — MUST be declared before phoenix_kit_routes()

scope "/phoenix_kit", MyAppWeb do

  pipe_through [:browser, :phoenix_kit_authenticated]

  live "/admin/entities/:entity_slug/data/:id", MyCustomDataView, :show

end



phoenix_kit_routes()

```



Phoenix matches routes in declaration order, so the custom route wins and

`DataView` is never reached.



## Additional Reading



- Overview: `OVERVIEW.md` (in this directory)

- Deep dive: `DEEP_DIVE.md` (in this directory)

- Languages module: `lib/modules/languages/README.md`



Keep this README in sync whenever new submodules or major workflows are added to the Entities

LiveView stack.