Phoenix

v1.5.3

Phoenix

Phoenix v1.5.3 mix phx.gen.live View Source

Generates LiveView, templates, and context for a resource.

mix phx.gen.live Accounts User users name:string age:integer

The first argument is the context module followed by the schema module and its plural name (used as the schema table name).

The context is an Elixir module that serves as an API boundary for the given resource. A context often holds many related resources. Therefore, if the context already exists, it will be augmented with functions for the given resource.

When this command is run for the first time, a ModalComponent and LiveHelpers module will be created, along with the resource level LiveViews and components, including an IndexLive, ShowLive, FormComponent for the new resource.

Note: A resource may also be split over distinct contexts (such as Accounts.User and Payments.User).

The schema is responsible for mapping the database fields into an Elixir struct. It is followed by an optional list of attributes, with their respective names and types. See mix phx.gen.schema for more information on attributes.

Overall, this generator will add the following files to lib/:

  • a context module in lib/app/accounts.ex for the accounts API
  • a schema in lib/app/accounts/user.ex, with an users table
  • a view in lib/app_web/views/user_view.ex
  • a LiveView in lib/app_web/live/user_live/show_live.ex
  • a LiveView in lib/app_web/live/user_live/index_live.ex
  • a LiveComponent in lib/app_web/live/user_live/form_component.ex
  • a LiveComponent in lib/app_web/live/modal_component.ex
  • a helpers modules in lib/app_web/live/live_helpers.ex

The context app

A migration file for the repository and test files for the context and controller features will also be generated.

The location of the web files (LiveView's, views, templates, etc) in an umbrella application will vary based on the :context_app config located in your applications :generators configuration. When set, the Phoenix generators will generate web files directly in your lib and test folders since the application is assumed to be isolated to web specific functionality. If :context_app is not set, the generators will place web related lib and test files in a web/ directory since the application is assumed to be handling both web and domain specific functionality. Example configuration:

config :my_app_web, :generators, context_app: :my_app

Alternatively, the --context-app option may be supplied to the generator:

mix phx.gen.live Sales User users --context-app warehouse

Web namespace

By default, the controller and view will be namespaced by the schema name. You can customize the web module namespace by passing the --web flag with a module name, for example:

mix phx.gen.live Sales User users --web Sales

Which would generate a LiveViews inside lib/app_web/live/sales/user_live/ and a view at lib/app_web/views/sales/user_view.ex.

Customising the context, schema, tables and migrations

In some cases, you may wish to bootstrap HTML templates, LiveViews, and tests, but leave internal implementation of the context or schema to yourself. You can use the --no-context and --no-schema flags for file generation control.

You can also change the table name or configure the migrations to use binary ids for primary keys, see mix phx.gen.schema for more information.