Pyro
Pyro
v0.1.1

View Source Pyro.Resource (Pyro v0.1.1)

An Ash resource extension providing declarative configuration of user interfaces via smart components.

dsl-documentation

 DSL Documentation

index

 Index

  • pyro
    • form
      • action
        • field
        • field_group
          • field
      • action_type
        • field
        • field_group
          • field
    • page

docs

 Docs

pyro

 pyro

Configure the pyro dashboard for a given resource

  • form
    • action
      • field
      • field_group
        • field
    • action_type
      • field
      • field_group
        • field
  • page

  • :resource_label (String.t/0) - The proper label to use when this resource appears in the pyro.

  • :default_sort (String.t/0) - The default sorting at page load.

  • :default_foreign_label (atom/0) - The default field to use as a label in a foreign relationship.

  • :default_card_fields (list of atom/0) - The list of fields to render in a card view.

  • :default_table_columns (list of atom/0) - The list of columns to render on the table view.

  • :default_display_mode - The default display mode for a resource's page. Defaults to :data_table. Valid values are :data_table, :card_grid

form

 form

Configure the appearance of forms in the Pyro.Resource extension.

action

  • field

  • field_group

    • field

  • :name - Required. The action name(s) for this form.

  • :label (String.t/0) - The label for this form.

  • :description (String.t/0) - The description for this form.

  • :class (String.t/0) - Merge/override the default class.

field

Declare non-default behavior for a specific form field in the Pyro.Resource extension.

  • :name (atom/0) - Required. The name of the field to be modified

  • :type - The type of the value in the form. Valid values are :default, :long_text, :short_text, :autocomplete, :select, :nested_form The default value is :default.

  • :options (list of term/0) - The options for a select type input. The default value is [].

  • :label (String.t/0) - Override the default extracted label.

  • :description (String.t/0) - Override the default extracted description.

  • :class (String.t/0) - Merge/override the default class.

  • :input_class (String.t/0) - Merge/override the default input class.

  • :autofocus (boolean/0) - Autofocus the field. The default value is false.

  • :prompt (String.t/0) - Override the default prompt.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

  • :autocomplete_search_action (atom/0) - Set the autocomplete search action name. The default value is :autocomplete.

  • :autocomplete_search_arg (atom/0) - Set the autocomplete search argument key. The default value is :search.

  • :autocomplete_option_label_key (atom/0) - Override the default autocomplete key used as a label. The default value is :label.

  • :autocomplete_option_value_key (atom/0) - Override the default autocomplete key used as a value. The default value is :id.

field_group

Configure the appearance of form field groups in the Pyro.Resource extension.

  • field

  • :name (atom/0) - Required. The name of the field to be modified

  • :label (String.t/0) - The label for this group.

  • :class (String.t/0) - Merge/override the default class.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

####### field

Declare non-default behavior for a specific form field in the Pyro.Resource extension.

  • :name (atom/0) - Required. The name of the field to be modified

  • :type - The type of the value in the form. Valid values are :default, :long_text, :short_text, :autocomplete, :select, :nested_form The default value is :default.

  • :options (list of term/0) - The options for a select type input. The default value is [].

  • :label (String.t/0) - Override the default extracted label.

  • :description (String.t/0) - Override the default extracted description.

  • :class (String.t/0) - Merge/override the default class.

  • :input_class (String.t/0) - Merge/override the default input class.

  • :autofocus (boolean/0) - Autofocus the field. The default value is false.

  • :prompt (String.t/0) - Override the default prompt.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

  • :autocomplete_search_action (atom/0) - Set the autocomplete search action name. The default value is :autocomplete.

  • :autocomplete_search_arg (atom/0) - Set the autocomplete search argument key. The default value is :search.

  • :autocomplete_option_label_key (atom/0) - Override the default autocomplete key used as a label. The default value is :label.

  • :autocomplete_option_value_key (atom/0) - Override the default autocomplete key used as a value. The default value is :id.

action_type

field

Declare non-default behavior for a specific form field in the Pyro.Resource extension.

  • :name (atom/0) - Required. The name of the field to be modified

  • :type - The type of the value in the form. Valid values are :default, :long_text, :short_text, :autocomplete, :select, :nested_form The default value is :default.

  • :options (list of term/0) - The options for a select type input. The default value is [].

  • :label (String.t/0) - Override the default extracted label.

  • :description (String.t/0) - Override the default extracted description.

  • :class (String.t/0) - Merge/override the default class.

  • :input_class (String.t/0) - Merge/override the default input class.

  • :autofocus (boolean/0) - Autofocus the field. The default value is false.

  • :prompt (String.t/0) - Override the default prompt.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

  • :autocomplete_search_action (atom/0) - Set the autocomplete search action name. The default value is :autocomplete.

  • :autocomplete_search_arg (atom/0) - Set the autocomplete search argument key. The default value is :search.

  • :autocomplete_option_label_key (atom/0) - Override the default autocomplete key used as a label. The default value is :label.

  • :autocomplete_option_value_key (atom/0) - Override the default autocomplete key used as a value. The default value is :id.

field_group

Configure the appearance of form field groups in the Pyro.Resource extension.

  • field

  • :name (atom/0) - Required. The name of the field to be modified

  • :label (String.t/0) - The label for this group.

  • :class (String.t/0) - Merge/override the default class.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

####### field

Declare non-default behavior for a specific form field in the Pyro.Resource extension.

  • :name (atom/0) - Required. The name of the field to be modified

  • :type - The type of the value in the form. Valid values are :default, :long_text, :short_text, :autocomplete, :select, :nested_form The default value is :default.

  • :options (list of term/0) - The options for a select type input. The default value is [].

  • :label (String.t/0) - Override the default extracted label.

  • :description (String.t/0) - Override the default extracted description.

  • :class (String.t/0) - Merge/override the default class.

  • :input_class (String.t/0) - Merge/override the default input class.

  • :autofocus (boolean/0) - Autofocus the field. The default value is false.

  • :prompt (String.t/0) - Override the default prompt.

  • :path (list of atom/0) - Override the default path (nested paths are appended).

  • :autocomplete_search_action (atom/0) - Set the autocomplete search action name. The default value is :autocomplete.

  • :autocomplete_search_arg (atom/0) - Set the autocomplete search argument key. The default value is :search.

  • :autocomplete_option_label_key (atom/0) - Override the default autocomplete key used as a label. The default value is :label.

  • :autocomplete_option_value_key (atom/0) - Override the default autocomplete key used as a value. The default value is :id.

page

 page

Configure this resource as a page.

  • :module (atom/0) - The live_view module to use for the page (defaults to an automatically generated page).

  • :route_path (String.t/0) - Required. The route path for the page