MishkaGervaz.Table.Entities.Filter.Preload (MishkaGervaz v0.0.1-alpha.3)

Copy Markdown View Source

Preload configuration for relation filters.

Defines which relationships to load for display_field rendering, with support for different preloads based on user type.

Example

filter :media_category_id, :relation do
  display_field fn r -> "#{r.name} - #{r.site.name}" end

  preload do
    always [:site]
    tenant [:category]
    master master_category: :category
  end
end

Summary

Types

preload_spec()

@type preload_spec() :: atom() | {atom(), atom()} | list()

t()

@type t() :: %MishkaGervaz.Table.Entities.Filter.Preload{
  __spark_metadata__: map() | nil,
  always: [preload_spec()] | nil,
  master: [preload_spec()] | nil,
  tenant: [preload_spec()] | nil
}

Functions

transform(preload)