iron_admin 0.7.0 → 0.8.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +129 -1
- data/README.md +48 -1
- data/UPGRADING.md +495 -8
- data/app/assets/tailwind/iron_admin/engine.css +79 -4
- data/app/components/iron_admin/dashboards/activity_feed_component/item_component.html.haml +6 -9
- data/app/components/iron_admin/dashboards/activity_feed_component.html.haml +6 -5
- data/app/components/iron_admin/dashboards/activity_feed_component.rb +21 -24
- data/app/components/iron_admin/dashboards/chart_component.html.haml +3 -5
- data/app/components/iron_admin/dashboards/chart_component.rb +86 -24
- data/app/components/iron_admin/dashboards/concerns/themed_card.rb +39 -0
- data/app/components/iron_admin/dashboards/metric_card_component.html.haml +8 -7
- data/app/components/iron_admin/dashboards/metric_card_component.rb +2 -0
- data/app/components/iron_admin/dashboards/progress_component.html.haml +11 -7
- data/app/components/iron_admin/dashboards/progress_component.rb +11 -6
- data/app/components/iron_admin/dashboards/quick_links_component/link_component.html.haml +8 -9
- data/app/components/iron_admin/dashboards/quick_links_component.html.haml +6 -5
- data/app/components/iron_admin/dashboards/quick_links_component.rb +4 -12
- data/app/components/iron_admin/dashboards/recent_table_component.html.haml +15 -10
- data/app/components/iron_admin/dashboards/recent_table_component.rb +49 -0
- data/app/components/iron_admin/dashboards/stats_grid_component/stat_component.html.haml +13 -14
- data/app/components/iron_admin/dashboards/stats_grid_component.html.haml +1 -0
- data/app/components/iron_admin/dashboards/stats_grid_component.rb +9 -11
- data/app/components/iron_admin/filters/bar_component.html.haml +8 -6
- data/app/components/iron_admin/filters/bar_component.rb +56 -9
- data/app/components/iron_admin/filters/control_styles.rb +82 -0
- data/app/components/iron_admin/filters/date_range_component.html.haml +9 -4
- data/app/components/iron_admin/filters/date_range_component.rb +10 -6
- data/app/components/iron_admin/filters/search_component.html.haml +4 -4
- data/app/components/iron_admin/filters/search_component.rb +3 -5
- data/app/components/iron_admin/filters/select_filter_component.html.haml +1 -1
- data/app/components/iron_admin/filters/select_filter_component.rb +5 -16
- data/app/components/iron_admin/form/belongs_to_autocomplete_component.html.haml +9 -5
- data/app/components/iron_admin/form/belongs_to_autocomplete_component.rb +10 -8
- data/app/components/iron_admin/form/belongs_to_component.html.haml +2 -2
- data/app/components/iron_admin/form/belongs_to_component.rb +4 -18
- data/app/components/iron_admin/form/checkbox_component.rb +2 -3
- data/app/components/iron_admin/form/concerns/form_input_behavior.rb +1 -1
- data/app/components/iron_admin/form/control_classes.rb +108 -0
- data/app/components/iron_admin/form/date_picker_component.rb +3 -7
- data/app/components/iron_admin/form/field_wrapper_component.html.haml +3 -3
- data/app/components/iron_admin/form/field_wrapper_component.rb +3 -3
- data/app/components/iron_admin/form/nested_form_component.html.haml +4 -5
- data/app/components/iron_admin/form/nested_form_component.rb +12 -2
- data/app/components/iron_admin/form/select_component.html.haml +1 -1
- data/app/components/iron_admin/form/select_component.rb +2 -16
- data/app/components/iron_admin/form/text_input_component.rb +1 -5
- data/app/components/iron_admin/form/textarea_component.rb +1 -5
- data/app/components/iron_admin/layout/flash_component.html.haml +1 -1
- data/app/components/iron_admin/layout/flash_component.rb +4 -3
- data/app/components/iron_admin/layout/navbar_component.html.haml +15 -9
- data/app/components/iron_admin/layout/navbar_component.rb +29 -1
- data/app/components/iron_admin/layout/shell_component.html.haml +4 -4
- data/app/components/iron_admin/layout/shell_component.rb +16 -3
- data/app/components/iron_admin/layout/sidebar_component.html.haml +21 -25
- data/app/components/iron_admin/layout/sidebar_component.rb +76 -1
- data/app/components/iron_admin/layout/theme_switcher_component.html.haml +15 -0
- data/app/components/iron_admin/layout/theme_switcher_component.rb +74 -0
- data/app/components/iron_admin/resources/actions_component.html.haml +15 -8
- data/app/components/iron_admin/resources/actions_component.rb +34 -2
- data/app/components/iron_admin/resources/breadcrumb_component.html.haml +3 -3
- data/app/components/iron_admin/resources/breadcrumb_component.rb +8 -7
- data/app/components/iron_admin/resources/bulk_actions_component.html.haml +9 -8
- data/app/components/iron_admin/resources/bulk_actions_component.rb +47 -4
- data/app/components/iron_admin/resources/data_table_component.html.haml +15 -15
- data/app/components/iron_admin/resources/data_table_component.rb +34 -3
- data/app/components/iron_admin/resources/related_list_component.html.haml +7 -7
- data/app/components/iron_admin/resources/related_list_component.rb +26 -2
- data/app/components/iron_admin/resources/show_field_component.html.haml +3 -3
- data/app/components/iron_admin/resources/show_field_component.rb +10 -4
- data/app/components/iron_admin/resources/styles.rb +136 -0
- data/app/components/iron_admin/ui/alert_component.html.haml +2 -2
- data/app/components/iron_admin/ui/alert_component.rb +27 -31
- data/app/components/iron_admin/ui/badge_component.rb +40 -20
- data/app/components/iron_admin/ui/button_component.rb +37 -11
- data/app/components/iron_admin/ui/card_component.rb +3 -3
- data/app/components/iron_admin/ui/dropdown_component.html.haml +1 -1
- data/app/components/iron_admin/ui/dropdown_component.rb +34 -13
- data/app/components/iron_admin/ui/empty_state_component.html.haml +4 -5
- data/app/components/iron_admin/ui/empty_state_component.rb +2 -2
- data/app/components/iron_admin/ui/modal_component.html.haml +5 -5
- data/app/components/iron_admin/ui/modal_component.rb +6 -4
- data/app/components/iron_admin/ui/pagination_component.html.haml +14 -14
- data/app/components/iron_admin/ui/pagination_component.rb +26 -9
- data/app/components/iron_admin/ui/scopes_component.html.haml +2 -2
- data/app/components/iron_admin/ui/scopes_component.rb +44 -11
- data/app/components/iron_admin/ui/tooltip_component.rb +11 -4
- data/app/controllers/iron_admin/application_controller.rb +58 -4
- data/app/controllers/iron_admin/audit_controller.rb +30 -6
- data/app/controllers/iron_admin/concerns/action_executable.rb +37 -0
- data/app/controllers/iron_admin/concerns/assignable_references.rb +149 -0
- data/app/controllers/iron_admin/concerns/authorizable.rb +11 -0
- data/app/controllers/iron_admin/concerns/blank_password_filterable.rb +21 -0
- data/app/controllers/iron_admin/concerns/event_emittable.rb +47 -7
- data/app/controllers/iron_admin/concerns/filterable.rb +34 -9
- data/app/controllers/iron_admin/concerns/nested_permittable.rb +5 -3
- data/app/controllers/iron_admin/concerns/nested_tenant_check.rb +159 -0
- data/app/controllers/iron_admin/concerns/polymorphic_references.rb +131 -0
- data/app/controllers/iron_admin/concerns/scopeable.rb +54 -7
- data/app/controllers/iron_admin/concerns/searchable.rb +3 -3
- data/app/controllers/iron_admin/concerns/tenant_assignable.rb +118 -0
- data/app/controllers/iron_admin/concerns/tenant_containment.rb +146 -0
- data/app/controllers/iron_admin/exports_controller.rb +2 -2
- data/app/controllers/iron_admin/imports_controller.rb +1 -1
- data/app/controllers/iron_admin/resources_controller.rb +48 -41
- data/app/controllers/iron_admin/search_controller.rb +1 -2
- data/app/controllers/iron_admin/themes_controller.rb +50 -0
- data/app/controllers/iron_admin/tools_controller.rb +58 -5
- data/app/helpers/iron_admin/action_form_helper.rb +19 -0
- data/app/helpers/iron_admin/application_helper.rb +93 -16
- data/app/helpers/iron_admin/assignable_records_helper.rb +32 -0
- data/app/helpers/iron_admin/component_overrides_helper.rb +9 -4
- data/app/helpers/iron_admin/field_display_helper.rb +88 -43
- data/app/helpers/iron_admin/related_records_helper.rb +51 -0
- data/app/helpers/iron_admin/theme_helper.rb +56 -46
- data/app/javascript/iron_admin/controllers/cp_bulk_select_controller.js +12 -0
- data/app/javascript/iron_admin/controllers/cp_chart_controller.js +4 -0
- data/app/javascript/iron_admin/controllers/cp_disclosure_controller.js +19 -0
- data/app/javascript/iron_admin/controllers/cp_search_shortcut_controller.js +39 -0
- data/app/javascript/iron_admin/index.js +4 -0
- data/app/views/iron_admin/audit/index.html.haml +78 -81
- data/app/views/iron_admin/dashboard/index.html.haml +10 -9
- data/app/views/iron_admin/form/_action_field.html.haml +50 -0
- data/app/views/iron_admin/form/_nested_row.html.haml +18 -13
- data/app/views/iron_admin/imports/new.html.haml +14 -13
- data/app/views/iron_admin/imports/preview.html.haml +24 -21
- data/app/views/iron_admin/resources/_form.html.haml +70 -68
- data/app/views/iron_admin/resources/action_form.html.haml +16 -59
- data/app/views/iron_admin/resources/bulk_action_form.html.haml +20 -58
- data/app/views/iron_admin/resources/edit.html.haml +3 -3
- data/app/views/iron_admin/resources/index.html.haml +87 -74
- data/app/views/iron_admin/resources/new.html.haml +2 -2
- data/app/views/iron_admin/resources/show.html.haml +53 -41
- data/app/views/iron_admin/search/index.html.haml +17 -9
- data/app/views/iron_admin/shared/_pagination.html.haml +13 -10
- data/app/views/iron_admin/shared/error.html.haml +16 -12
- data/app/views/iron_admin/tools/action_form.html.haml +9 -55
- data/app/views/iron_admin/tools/show.html.haml +4 -5
- data/app/views/layouts/iron_admin/_document_head.html.haml +24 -0
- data/app/views/layouts/iron_admin/application.html.haml +4 -17
- data/app/views/layouts/iron_admin/minimal.html.haml +7 -0
- data/config/importmap.rb +2 -0
- data/config/locales/en.yml +23 -0
- data/config/routes.rb +1 -0
- data/docs/FAQ.md +87 -37
- data/docs/README.md +8 -2
- data/docs/components/README.md +6 -2
- data/docs/components/dashboard-components.md +24 -35
- data/docs/components/filter-components.md +44 -92
- data/docs/components/form-components.md +16 -32
- data/docs/components/resource-components.md +46 -27
- data/docs/components/ui-components.md +44 -26
- data/docs/getting-started/installation.md +5 -1
- data/docs/getting-started/quick-start.md +36 -23
- data/docs/guides/authentication.md +182 -42
- data/docs/guides/components.md +97 -15
- data/docs/guides/custom-adapters.md +24 -4
- data/docs/guides/dashboard.md +68 -44
- data/docs/guides/export.md +24 -8
- data/docs/guides/extending.md +206 -51
- data/docs/guides/fields.md +229 -70
- data/docs/guides/imports.md +33 -18
- data/docs/guides/resources.md +333 -111
- data/docs/guides/theming.md +930 -58
- data/docs/guides/troubleshooting.md +7 -3
- data/docs/plugin-system-design.md +8 -7
- data/docs/reference/configuration.md +51 -16
- data/docs/reference/routes.md +1 -0
- data/docs/reference/theme-properties.md +101 -38
- data/lib/generators/iron_admin/install/templates/initializer.rb.tt +7 -2
- data/lib/generators/iron_admin/install_audit/templates/create_iron_admin_audit_entries.rb.tt +2 -0
- data/lib/iron_admin/action_field.rb +11 -0
- data/lib/iron_admin/adapters/active_record.rb +95 -0
- data/lib/iron_admin/adapters/base.rb +107 -0
- data/lib/iron_admin/adapters/http/query.rb +21 -0
- data/lib/iron_admin/adapters/http.rb +84 -4
- data/lib/iron_admin/adapters/mongoid.rb +96 -2
- data/lib/iron_admin/audit_log.rb +64 -6
- data/lib/iron_admin/authentication_warning.rb +31 -0
- data/lib/iron_admin/concerns/filter_definable.rb +15 -1
- data/lib/iron_admin/concerns/nestable.rb +25 -0
- data/lib/iron_admin/concerns/scope_countable.rb +56 -0
- data/lib/iron_admin/concerns/soft_deletable.rb +28 -9
- data/lib/iron_admin/configuration/components.rb +14 -3
- data/lib/iron_admin/configuration/theme/neutral_defaults.rb +179 -0
- data/lib/iron_admin/configuration/theme.rb +292 -87
- data/lib/iron_admin/configuration.rb +340 -45
- data/lib/iron_admin/dashboard.rb +22 -38
- data/lib/iron_admin/engine.rb +16 -2
- data/lib/iron_admin/errors.rb +3 -0
- data/lib/iron_admin/field.rb +78 -17
- data/lib/iron_admin/field_inferrer.rb +61 -3
- data/lib/iron_admin/field_override_warning.rb +67 -0
- data/lib/iron_admin/import/import_preview.rb +56 -7
- data/lib/iron_admin/import/importer.rb +91 -14
- data/lib/iron_admin/import/tenant_precheck.rb +67 -0
- data/lib/iron_admin/plugin/registration.rb +64 -0
- data/lib/iron_admin/plugin_registry.rb +3 -2
- data/lib/iron_admin/policy.rb +22 -12
- data/lib/iron_admin/policy_coverage_warning.rb +46 -0
- data/lib/iron_admin/request_context.rb +18 -0
- data/lib/iron_admin/resource.rb +218 -77
- data/lib/iron_admin/resource_registry.rb +86 -13
- data/lib/iron_admin/scope_counts.rb +73 -0
- data/lib/iron_admin/tenant_scope.rb +30 -0
- data/lib/iron_admin/tool.rb +61 -12
- data/lib/iron_admin/tool_context.rb +10 -6
- data/lib/iron_admin/version.rb +1 -1
- data/lib/iron_admin.rb +29 -2
- metadata +37 -7
|
@@ -0,0 +1,56 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
module IronAdmin
|
|
4
|
+
module Concerns
|
|
5
|
+
# Per-resource switch for the record counts on scope tabs.
|
|
6
|
+
#
|
|
7
|
+
# A resource that never calls {ScopeCountDsl#scope_counts} follows
|
|
8
|
+
# {Configuration#scope_counts}. Extracted from {IronAdmin::Resource} so
|
|
9
|
+
# the parent class stays under the Metrics/ClassLength budget.
|
|
10
|
+
module ScopeCountable
|
|
11
|
+
extend ActiveSupport::Concern
|
|
12
|
+
|
|
13
|
+
# The class methods {IronAdmin::Resource} uses to turn scope-tab counts
|
|
14
|
+
# on or off. A named module, because YARD does not document methods
|
|
15
|
+
# defined inside +class_methods+.
|
|
16
|
+
module ScopeCountDsl
|
|
17
|
+
# Turns scope-tab counts on or off for this resource.
|
|
18
|
+
#
|
|
19
|
+
# Each counted scope costs one query on the index. +false+ draws
|
|
20
|
+
# every tab with its name only. Omit the call to follow
|
|
21
|
+
# {Configuration#scope_counts}.
|
|
22
|
+
#
|
|
23
|
+
# @param enabled [Boolean] +false+ turns the counts off. Omit it, or
|
|
24
|
+
# pass +true+, to turn them on for this resource.
|
|
25
|
+
# @return [void]
|
|
26
|
+
# @example
|
|
27
|
+
# module IronAdmin
|
|
28
|
+
# module Resources
|
|
29
|
+
# class UserResource < IronAdmin::Resource
|
|
30
|
+
# scope_counts true
|
|
31
|
+
# end
|
|
32
|
+
# end
|
|
33
|
+
# end
|
|
34
|
+
def scope_counts(enabled = nil)
|
|
35
|
+
self._scope_counts = enabled.nil? || enabled
|
|
36
|
+
end
|
|
37
|
+
|
|
38
|
+
# @return [Boolean] whether this resource's index counts each scope
|
|
39
|
+
def scope_counts_enabled?
|
|
40
|
+
return _scope_counts unless _scope_counts.nil?
|
|
41
|
+
|
|
42
|
+
IronAdmin.configuration.scope_counts
|
|
43
|
+
end
|
|
44
|
+
end
|
|
45
|
+
|
|
46
|
+
included do
|
|
47
|
+
# +nil+ follows the global setting. +true+ or +false+ overrides it.
|
|
48
|
+
class_attribute :_scope_counts, default: nil
|
|
49
|
+
end
|
|
50
|
+
|
|
51
|
+
class_methods do
|
|
52
|
+
include ScopeCountDsl
|
|
53
|
+
end
|
|
54
|
+
end
|
|
55
|
+
end
|
|
56
|
+
end
|
|
@@ -4,9 +4,10 @@ require "active_support/concern"
|
|
|
4
4
|
|
|
5
5
|
module IronAdmin
|
|
6
6
|
module Concerns
|
|
7
|
-
# Adds the auto-registered soft-delete features
|
|
8
|
-
# `
|
|
9
|
-
#
|
|
7
|
+
# Adds the auto-registered soft-delete features when the underlying
|
|
8
|
+
# model has a `deleted_at` column. `:restore` is always registered.
|
|
9
|
+
# `with_deleted` and `only_deleted` are registered only when
|
|
10
|
+
# `adapter.supports_soft_delete_tabs?` is true.
|
|
10
11
|
#
|
|
11
12
|
# Extracted from `IronAdmin::Resource` so the registration logic can
|
|
12
13
|
# evolve independently — and so the parent class stays under the
|
|
@@ -38,12 +39,10 @@ module IronAdmin
|
|
|
38
39
|
return @soft_delete_features_registered = true unless soft_delete?
|
|
39
40
|
|
|
40
41
|
column = soft_delete_column
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
{ name: :only_deleted, scope: -> { unscope(where: column_sym).where.not(column => nil) }, default: false },
|
|
46
|
-
]
|
|
42
|
+
# ActiveRecord can run these bodies. Other adapters cannot (no
|
|
43
|
+
# unscope), so counting them would fail on every index.
|
|
44
|
+
skip = adapter.is_a?(IronAdmin::Adapters::ActiveRecord) ? {} : { count: false }
|
|
45
|
+
self._soft_delete_scopes = SoftDeletable.scope_tabs(self, column, skip)
|
|
47
46
|
|
|
48
47
|
action :restore, icon: "arrow-path", condition: ->(record) { record.public_send(column).present? } do |record|
|
|
49
48
|
record.update(column => nil)
|
|
@@ -56,6 +55,26 @@ module IronAdmin
|
|
|
56
55
|
nil
|
|
57
56
|
end
|
|
58
57
|
end
|
|
58
|
+
|
|
59
|
+
# The `with_deleted` and `only_deleted` tabs, or none when the
|
|
60
|
+
# resource's adapter cannot run them. Zero-arity bodies:
|
|
61
|
+
# Relation#merge and Scopeable#apply_resource_scope run them with
|
|
62
|
+
# instance_exec and no argument, so self is the relation. The adapter
|
|
63
|
+
# is resolved at call time; registration clears `@adapter`.
|
|
64
|
+
#
|
|
65
|
+
# @api private
|
|
66
|
+
# @param resource [Class] the resource class
|
|
67
|
+
# @param column [String] the soft-delete column
|
|
68
|
+
# @param skip [Hash] extra keys for each tab (`{ count: false }` or `{}`)
|
|
69
|
+
# @return [Array<Hash>]
|
|
70
|
+
def self.scope_tabs(resource, column, skip)
|
|
71
|
+
return [] unless resource.adapter.supports_soft_delete_tabs?
|
|
72
|
+
|
|
73
|
+
[
|
|
74
|
+
{ name: :with_deleted, scope: -> { resource.adapter.unscope_column(self, column) }, default: false, **skip },
|
|
75
|
+
{ name: :only_deleted, scope: -> { resource.adapter.only_soft_deleted(self, column) }, default: false, **skip },
|
|
76
|
+
]
|
|
77
|
+
end
|
|
59
78
|
end
|
|
60
79
|
end
|
|
61
80
|
end
|
|
@@ -11,14 +11,23 @@ module IronAdmin
|
|
|
11
11
|
class Components
|
|
12
12
|
# Keyword arguments IronAdmin passes to each slot's component. A component
|
|
13
13
|
# gets the ones its +initialize+ declares (all of them with +**options+)
|
|
14
|
-
# and must not require others. +fields+ and +filters+ are the visible ones
|
|
14
|
+
# and must not require others. +fields+ and +filters+ are the visible ones;
|
|
15
|
+
# +flash+ is the request's flash. The +filter_bar+ slot's +scope+, +query+,
|
|
16
|
+
# +current_sort+ and +current_direction+ are what its form keeps as the
|
|
17
|
+
# +scope+, +q+, +sort+ and +direction+ hidden fields (nil when not set).
|
|
18
|
+
# +bulk_actions+ on +table+ is the bulk actions the policy allows for
|
|
19
|
+
# the current user, and is empty when it allows none.
|
|
15
20
|
SLOTS = {
|
|
16
21
|
shell: %i[current_user],
|
|
17
22
|
navbar: %i[current_user title],
|
|
18
23
|
sidebar: %i[current_user],
|
|
19
|
-
|
|
24
|
+
flash: %i[flash current_user],
|
|
25
|
+
theme_switcher: %i[themes current_theme current_user],
|
|
26
|
+
table: %i[records fields resource_class current_user current_sort current_direction scope query base_url
|
|
27
|
+
bulk_actions],
|
|
20
28
|
form: %i[record fields resource_class url current_user],
|
|
21
|
-
filter_bar: %i[filters resource_class form_url scope query active_count current_user
|
|
29
|
+
filter_bar: %i[filters resource_class form_url scope query active_count current_user
|
|
30
|
+
current_sort current_direction],
|
|
22
31
|
search: %i[resource_class form_url value placeholder hidden_params current_user],
|
|
23
32
|
}.freeze
|
|
24
33
|
|
|
@@ -30,6 +39,8 @@ module IronAdmin
|
|
|
30
39
|
shell: "IronAdmin::Layout::ShellComponent",
|
|
31
40
|
navbar: "IronAdmin::Layout::NavbarComponent",
|
|
32
41
|
sidebar: "IronAdmin::Layout::SidebarComponent",
|
|
42
|
+
flash: "IronAdmin::Layout::FlashComponent",
|
|
43
|
+
theme_switcher: "IronAdmin::Layout::ThemeSwitcherComponent",
|
|
33
44
|
}.freeze
|
|
34
45
|
|
|
35
46
|
# Keyword arguments a {#fields} component receives.
|
|
@@ -0,0 +1,179 @@
|
|
|
1
|
+
# frozen_string_literal: true
|
|
2
|
+
|
|
3
|
+
# The values of the built-in Neutral look. Theme#initialize calls these methods, so every new
|
|
4
|
+
# theme starts with them; each property of the theme gets its Neutral value here.
|
|
5
|
+
|
|
6
|
+
module IronAdmin
|
|
7
|
+
class Configuration
|
|
8
|
+
class Theme
|
|
9
|
+
private
|
|
10
|
+
|
|
11
|
+
def init_control_defaults
|
|
12
|
+
@btn_primary = "bg-zinc-900 text-white hover:bg-zinc-700 " \
|
|
13
|
+
"focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-500"
|
|
14
|
+
@btn_secondary = "bg-white text-zinc-900 border border-zinc-200 hover:bg-zinc-50 hover:border-zinc-300"
|
|
15
|
+
@btn_danger = "bg-red-600 text-white hover:bg-red-700"
|
|
16
|
+
@btn_ghost = "bg-transparent text-zinc-700 hover:bg-zinc-100 hover:text-zinc-900"
|
|
17
|
+
@link = "text-indigo-600 hover:text-indigo-700"
|
|
18
|
+
@link_muted = "text-zinc-500 hover:text-zinc-900"
|
|
19
|
+
@focus_ring = "focus-visible:outline-2 focus-visible:outline-offset-2 focus-visible:outline-indigo-500"
|
|
20
|
+
@control_radius = "rounded-md"
|
|
21
|
+
@control_shadow = "shadow-xs"
|
|
22
|
+
end
|
|
23
|
+
|
|
24
|
+
def init_form_defaults
|
|
25
|
+
# zinc-500 at 80% keeps an empty input's outline at 3:1 on white and zinc-50 (WCAG 1.4.11)
|
|
26
|
+
@input_border = "border-zinc-500/80 hover:border-zinc-500"
|
|
27
|
+
@input_focus = "focus:border-indigo-500 focus:ring-3 focus:ring-indigo-500/15"
|
|
28
|
+
@checkbox_checked = "checked:border-indigo-600 checked:bg-indigo-600 focus:ring-3 focus:ring-indigo-500/15"
|
|
29
|
+
@checkbox_border = "border-zinc-500"
|
|
30
|
+
@checkbox_radius = "rounded-sm"
|
|
31
|
+
@input_error = "border-red-500 focus:border-red-600 focus:ring-3 focus:ring-red-500/20"
|
|
32
|
+
@placeholder_text = "placeholder:text-zinc-500"
|
|
33
|
+
@disabled_text = "text-zinc-300"
|
|
34
|
+
init_rich_text_defaults
|
|
35
|
+
end
|
|
36
|
+
|
|
37
|
+
# The rich text editor is outlined like the inputs; the toolbar's groups, buttons and link dialog
|
|
38
|
+
# take Neutral's borders, radii and shadow (with ! to win over trix.css).
|
|
39
|
+
def init_rich_text_defaults
|
|
40
|
+
@rich_text_editor = "border rounded-md border-zinc-500/80 hover:border-zinc-500 bg-white text-zinc-900 shadow-xs " \
|
|
41
|
+
"focus:border-indigo-500 focus:ring-3 focus:ring-indigo-500/15"
|
|
42
|
+
@rich_text_toolbar = "[&_.trix-button-group]:border-zinc-200! [&_.trix-button-group]:rounded-md! " \
|
|
43
|
+
"[&_.trix-button-group]:overflow-hidden! [&_.trix-button]:border-zinc-200! " \
|
|
44
|
+
"[&_.trix-button]:border-b-0! [&_.trix-button.trix-active]:bg-zinc-100! " \
|
|
45
|
+
"[&_.trix-dialog]:border! [&_.trix-dialog]:border-zinc-200! [&_.trix-dialog]:rounded-lg! " \
|
|
46
|
+
"[&_.trix-dialog]:shadow-lg! [&_.trix-input--dialog]:border-zinc-500/80! " \
|
|
47
|
+
"[&_.trix-input--dialog]:rounded-md!"
|
|
48
|
+
end
|
|
49
|
+
|
|
50
|
+
def init_navigation_defaults
|
|
51
|
+
@scope_active = "border-zinc-900 text-zinc-900"
|
|
52
|
+
@scope_inactive = "border-transparent text-zinc-500 hover:text-zinc-900 hover:border-zinc-300"
|
|
53
|
+
@badge_count = "bg-zinc-100 text-zinc-700"
|
|
54
|
+
@sidebar_bg = "bg-zinc-50"
|
|
55
|
+
@sidebar_border = "lg:border-r border-zinc-200"
|
|
56
|
+
@sidebar_title = "text-zinc-900"
|
|
57
|
+
@sidebar_link = "text-zinc-600"
|
|
58
|
+
@sidebar_link_hover = "hover:bg-zinc-200/60 hover:text-zinc-900"
|
|
59
|
+
@sidebar_link_active = "bg-white text-zinc-900 shadow-xs ring-1 ring-zinc-200 before:absolute before:left-0 " \
|
|
60
|
+
"before:inset-y-2 before:w-0.5 before:rounded-full before:bg-indigo-500"
|
|
61
|
+
@sidebar_group_label = "text-zinc-500"
|
|
62
|
+
@navbar_bg = "bg-white"
|
|
63
|
+
@navbar_border = "border-zinc-200"
|
|
64
|
+
@navbar_border_width = "border-b"
|
|
65
|
+
@navbar_search_bg = "bg-zinc-50"
|
|
66
|
+
@navbar_search_focus_bg = "focus:bg-white"
|
|
67
|
+
@navbar_text = "text-zinc-600"
|
|
68
|
+
@kbd = "border-zinc-200 bg-white text-zinc-500"
|
|
69
|
+
@skip_link = "focus:bg-white focus:text-zinc-900 focus:ring-2 focus:ring-indigo-500"
|
|
70
|
+
end
|
|
71
|
+
|
|
72
|
+
def init_surface_defaults
|
|
73
|
+
@table_header_bg = "bg-zinc-50"
|
|
74
|
+
@table_header_text = "text-xs font-medium text-zinc-500"
|
|
75
|
+
@table_cell_padding = "px-4 py-2.5"
|
|
76
|
+
@table_frame = ""
|
|
77
|
+
@table_sticky_shadow = "shadow-[-4px_0_6px_-4px_rgba(0,0,0,0.08)]"
|
|
78
|
+
@table_row_hover = "hover:bg-zinc-50"
|
|
79
|
+
@table_sticky_row_hover = ""
|
|
80
|
+
@table_border = "divide-zinc-200"
|
|
81
|
+
@table_head_border = ""
|
|
82
|
+
@card_bg = "bg-white"
|
|
83
|
+
@card_border = "border-zinc-200"
|
|
84
|
+
@card_shadow = "shadow-xs"
|
|
85
|
+
@popover_shadow = "shadow-lg"
|
|
86
|
+
@popover_bg = ""
|
|
87
|
+
@card_title = "text-sm font-semibold text-zinc-900"
|
|
88
|
+
@main_bg = "bg-zinc-50"
|
|
89
|
+
@border_radius = "rounded-lg"
|
|
90
|
+
@border_width = "border"
|
|
91
|
+
@color_scheme = "light"
|
|
92
|
+
@swatch = "rounded-full bg-white ring-1 ring-inset ring-zinc-500/80"
|
|
93
|
+
@surface_muted = "bg-zinc-50"
|
|
94
|
+
@item_hover = "hover:bg-zinc-100"
|
|
95
|
+
@item_active = "bg-zinc-100"
|
|
96
|
+
@icon_muted = "text-zinc-400"
|
|
97
|
+
@overlay_bg = "bg-zinc-900/40"
|
|
98
|
+
end
|
|
99
|
+
|
|
100
|
+
def init_typography_defaults
|
|
101
|
+
@font_family = "font-[family-name:Inter,ui-sans-serif,system-ui,sans-serif]"
|
|
102
|
+
@font_stylesheet_url = "https://fonts.googleapis.com/css2?family=Inter:wght@400..700&display=swap"
|
|
103
|
+
@heading_font = ""
|
|
104
|
+
@heading_weight = "font-semibold"
|
|
105
|
+
@page_title = "text-xl font-semibold tracking-tight text-zinc-900"
|
|
106
|
+
@label_transform = ""
|
|
107
|
+
@field_label_transform = ""
|
|
108
|
+
@body_text = "text-zinc-900"
|
|
109
|
+
@muted_text = "text-zinc-500"
|
|
110
|
+
@label_text = "text-zinc-700"
|
|
111
|
+
@error_text = "text-red-600"
|
|
112
|
+
@success_text = "text-emerald-700"
|
|
113
|
+
end
|
|
114
|
+
|
|
115
|
+
def init_feedback_defaults
|
|
116
|
+
@badge_shape = "rounded-md font-medium"
|
|
117
|
+
@alert_shadow = ""
|
|
118
|
+
@chip = "bg-zinc-100 text-zinc-700 ring-1 ring-inset ring-zinc-200"
|
|
119
|
+
@danger_item = "text-red-600 hover:bg-red-50 hover:text-red-700"
|
|
120
|
+
@tooltip = "bg-zinc-900 text-white"
|
|
121
|
+
@code_block = "bg-zinc-950 text-zinc-100"
|
|
122
|
+
@code_font = "font-mono"
|
|
123
|
+
@progress_track = "bg-zinc-200"
|
|
124
|
+
@pagination_active = "bg-zinc-900 text-white border-zinc-900"
|
|
125
|
+
@metric_label = "text-xs font-medium text-zinc-500"
|
|
126
|
+
@metric_value = "text-2xl font-semibold tracking-tight tabular-nums text-zinc-900"
|
|
127
|
+
@metric_icon = "bg-zinc-100 text-zinc-500"
|
|
128
|
+
end
|
|
129
|
+
|
|
130
|
+
def init_palette_defaults
|
|
131
|
+
@alert_palette = {
|
|
132
|
+
success: "bg-emerald-50 border-emerald-200 text-emerald-800",
|
|
133
|
+
error: "bg-red-50 border-red-200 text-red-800",
|
|
134
|
+
warning: "bg-amber-50 border-amber-200 text-amber-800",
|
|
135
|
+
info: "bg-blue-50 border-blue-200 text-blue-800",
|
|
136
|
+
}
|
|
137
|
+
@badge_palette = {
|
|
138
|
+
green: "bg-emerald-50 text-emerald-700 ring-1 ring-inset ring-emerald-600/20",
|
|
139
|
+
red: "bg-red-50 text-red-700 ring-1 ring-inset ring-red-600/10",
|
|
140
|
+
yellow: "bg-amber-50 text-amber-800 ring-1 ring-inset ring-amber-600/20",
|
|
141
|
+
blue: "bg-blue-50 text-blue-700 ring-1 ring-inset ring-blue-700/10",
|
|
142
|
+
indigo: "bg-indigo-50 text-indigo-700 ring-1 ring-inset ring-indigo-700/10",
|
|
143
|
+
purple: "bg-purple-50 text-purple-700 ring-1 ring-inset ring-purple-700/10",
|
|
144
|
+
pink: "bg-pink-50 text-pink-700 ring-1 ring-inset ring-pink-700/10",
|
|
145
|
+
orange: "bg-orange-50 text-orange-800 ring-1 ring-inset ring-orange-600/20",
|
|
146
|
+
teal: "bg-teal-50 text-teal-700 ring-1 ring-inset ring-teal-600/20",
|
|
147
|
+
gray: "bg-zinc-50 text-zinc-600 ring-1 ring-inset ring-zinc-500/10",
|
|
148
|
+
}
|
|
149
|
+
@badge_dot_palette = {
|
|
150
|
+
green: "bg-emerald-500",
|
|
151
|
+
red: "bg-red-500",
|
|
152
|
+
yellow: "bg-amber-500",
|
|
153
|
+
blue: "bg-blue-500",
|
|
154
|
+
indigo: "bg-indigo-500",
|
|
155
|
+
purple: "bg-purple-500",
|
|
156
|
+
pink: "bg-pink-500",
|
|
157
|
+
orange: "bg-orange-500",
|
|
158
|
+
teal: "bg-teal-500",
|
|
159
|
+
gray: "bg-zinc-400",
|
|
160
|
+
}
|
|
161
|
+
end
|
|
162
|
+
|
|
163
|
+
def init_chart_defaults
|
|
164
|
+
# Indigo-500 (the accent), teal-600, then muted fuchsia, amber, sky and rose: each one has
|
|
165
|
+
# 3:1 contrast or more on the white cards (WCAG 1.4.11) and stays apart from the next one,
|
|
166
|
+
# and the last from the first (pie slices close the circle), for normal vision and the
|
|
167
|
+
# common color vision deficiencies
|
|
168
|
+
@chart_colors = %w[#6366f1 #0d9488 #b446c3 #d07d34 #2584c0 #d43b51]
|
|
169
|
+
@chart_border_color = "rgb(99, 102, 241)"
|
|
170
|
+
@chart_grid_color = "rgba(228, 228, 231, 1)"
|
|
171
|
+
@chart_text_color = "rgb(113, 113, 122)"
|
|
172
|
+
@chart_point_style = "circle"
|
|
173
|
+
# The white of the cards: a gap between neighboring slices
|
|
174
|
+
@chart_slice_border_color = "#ffffff"
|
|
175
|
+
@chart_border_width = nil
|
|
176
|
+
end
|
|
177
|
+
end
|
|
178
|
+
end
|
|
179
|
+
end
|