Module: BetterUi

Defined in:
lib/better_ui.rb,
lib/better_ui/engine.rb,
lib/better_ui/version.rb,
app/components/better_ui/tag_component.rb,
app/components/better_ui/card_component.rb,
app/components/better_ui/link_component.rb,
app/models/better_ui/application_record.rb,
app/components/better_ui/badge_component.rb,
app/helpers/better_ui/application_helper.rb,
app/components/better_ui/avatar_component.rb,
app/components/better_ui/button_component.rb,
app/components/better_ui/divider_component.rb,
app/components/better_ui/fa_icon_component.rb,
app/components/better_ui/heading_component.rb,
app/components/better_ui/spinner_component.rb,
app/components/better_ui/tooltip_component.rb,
app/components/better_ui/progress_component.rb,
app/components/better_ui/tabs/tab_component.rb,
app/form_builders/better_ui/ui_form_builder.rb,
app/components/better_ui/container_component.rb,
app/components/better_ui/table/row_component.rb,
app/components/better_ui/forms/base_component.rb,
app/components/better_ui/table/cell_component.rb,
app/components/better_ui/tabs/panel_component.rb,
app/components/better_ui/application_component.rb,
app/components/better_ui/table/table_component.rb,
app/components/better_ui/dialog/alert_component.rb,
app/components/better_ui/forms/select_component.rb,
app/components/better_ui/table/column_component.rb,
app/components/better_ui/table/header_component.rb,
app/components/better_ui/dialog/dialog_component.rb,
app/components/better_ui/drawer/header_component.rb,
app/components/better_ui/drawer/layout_component.rb,
app/components/better_ui/dropdown/item_component.rb,
app/controllers/better_ui/application_controller.rb,
app/components/better_ui/dialog/confirm_component.rb,
app/components/better_ui/drawer/sidebar_component.rb,
app/components/better_ui/forms/checkbox_component.rb,
app/components/better_ui/forms/textarea_component.rb,
app/components/better_ui/tabs/container_component.rb,
app/components/better_ui/action_messages_component.rb,
app/components/better_ui/breadcrumb/item_component.rb,
app/components/better_ui/drawer/nav_item_component.rb,
app/components/better_ui/dropdown/header_component.rb,
app/components/better_ui/table/concerns/sort_icons.rb,
lib/generators/better_ui/install/install_generator.rb,
app/components/better_ui/drawer/nav_group_component.rb,
app/components/better_ui/dropdown/divider_component.rb,
app/components/better_ui/forms/text_input_component.rb,
app/components/better_ui/dropdown/dropdown_component.rb,
app/components/better_ui/table/header_cell_component.rb,
app/components/better_ui/concerns/inline_label_styles.rb,
app/components/better_ui/forms/number_input_component.rb,
app/components/better_ui/forms/checkbox_group_component.rb,
app/components/better_ui/forms/password_input_component.rb,
app/components/better_ui/breadcrumb/breadcrumb_component.rb,
app/components/better_ui/pagination/pagination_component.rb

Defined Under Namespace

Modules: ApplicationHelper, Breadcrumb, Concerns, Dialog, Drawer, Dropdown, Forms, Generators, Pagination, Table, Tabs Classes: ActionMessagesComponent, ApplicationComponent, ApplicationController, ApplicationRecord, AvatarComponent, BadgeComponent, ButtonComponent, CardComponent, ContainerComponent, DividerComponent, Engine, FaIconComponent, HeadingComponent, LinkComponent, ProgressComponent, SpinnerComponent, TagComponent, TooltipComponent, UiFormBuilder

Constant Summary collapse

VERSION = 
"0.11.1"

Class Method Summary collapse

Class Method Details

.root ⇒ Pathname

Returns the root path of the BetterUi gem. This is useful when you need to reference gem assets or files.

Examples:

BetterUi.root
# => #<Pathname:/path/to/better_ui>

Returns:

  • (Pathname) —

    The root path of the gem



34
35
36
 
# File 'lib/better_ui.rb', line 34

def self.root
  Engine.root
end

.template_paths ⇒ Array<String>

Returns an array of paths where BetterUi templates are located. This is useful for debugging and documentation purposes.

Examples:

BetterUi.template_paths
# => ["/path/to/gem/app/views", "/path/to/gem/app/components"]

Returns:

  • (Array<String>) —

    Array of absolute paths to template directories



18
19
20
21
22
23
24
 
# File 'lib/better_ui.rb', line 18

def self.template_paths
  root = Engine.root
  [
    root.join("app", "views").to_s,
    root.join("app", "components").to_s
  ].select { |path| Dir.exist?(path) }
end