Class: IronAdmin::Configuration::Components

Inherits:
Object
  • Object
show all
Defined in:
lib/iron_admin/configuration/components.rb

Overview

Component override configuration for replacing default UI components.

Allows replacing the default ViewComponents with custom implementations at the global level. For per-resource overrides, use Resource.component.

Examples:

Override the table component globally

IronAdmin.configure do |config|
  config.components.table = MyCustomTableComponent
end

See Also:

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize ⇒ Components

Creates a new Components configuration with defaults.



42
43
44
 
# File 'lib/iron_admin/configuration/components.rb', line 42

def initialize
  @fields = {}
end

Instance Attribute Details

#fields ⇒ Hash{Symbol => Class} (readonly)

Returns Field type to component class mappings.

Returns:

  • (Hash{Symbol => Class}) —

    Field type to component class mappings



39
40
41
 
# File 'lib/iron_admin/configuration/components.rb', line 39

def fields
  @fields
end

#filter_bar ⇒ Class?

Returns Custom filter bar component class.

Returns:

  • (Class, nil) —

    Custom filter bar component class



24
25
26
 
# File 'lib/iron_admin/configuration/components.rb', line 24

def filter_bar
  @filter_bar
end

#form ⇒ Class?

Returns Custom form component class.

Returns:

  • (Class, nil) —

    Custom form component class



21
22
23
 
# File 'lib/iron_admin/configuration/components.rb', line 21

def form
  @form
end

#navbar ⇒ Class?

Returns Custom navbar component class.

Returns:

  • (Class, nil) —

    Custom navbar component class



30
31
32
 
# File 'lib/iron_admin/configuration/components.rb', line 30

def navbar
  @navbar
end

#search ⇒ Class?

Returns Custom search component class.

Returns:

  • (Class, nil) —

    Custom search component class



27
28
29
 
# File 'lib/iron_admin/configuration/components.rb', line 27

def search
  @search
end

#shell ⇒ Class?

Returns Custom shell/layout component class.

Returns:

  • (Class, nil) —

    Custom shell/layout component class



36
37
38
 
# File 'lib/iron_admin/configuration/components.rb', line 36

def shell
  @shell
end

#sidebar ⇒ Class?

Returns Custom sidebar component class.

Returns:

  • (Class, nil) —

    Custom sidebar component class



33
34
35
 
# File 'lib/iron_admin/configuration/components.rb', line 33

def sidebar
  @sidebar
end

#table ⇒ Class?

Returns Custom table component class.

Returns:

  • (Class, nil) —

    Custom table component class



18
19
20
 
# File 'lib/iron_admin/configuration/components.rb', line 18

def table
  @table
end