Module: DocsUI

Extended by:
Phlex::Kit
Included in:
Page
Defined in:
lib/docs_kit.rb,
app/components/docs_ui/code.rb,
app/components/docs_ui/icon.rb,
app/components/docs_ui/page.rb,
app/components/docs_ui/prose.rb,
app/components/docs_ui/shell.rb,
app/components/docs_ui/table.rb,
app/components/docs_ui/header.rb,
app/components/docs_ui/callout.rb,
app/components/docs_ui/example.rb,
app/components/docs_ui/landing.rb,
app/components/docs_ui/section.rb,
app/components/docs_ui/sidebar.rb,
app/components/docs_ui/endpoint.rb,
app/components/docs_ui/markdown.rb,
app/components/docs_ui/meta_tags.rb,
app/components/docs_ui/brand_mark.rb,
app/components/docs_ui/prop_table.rb,
app/components/docs_ui/search_box.rb,
app/components/docs_ui/error_table.rb,
app/components/docs_ui/field_table.rb,
app/components/docs_ui/on_this_page.rb,
app/components/docs_ui/page_helpers.rb,
app/components/docs_ui/topbar_links.rb,
app/components/docs_ui/json_response.rb,
app/components/docs_ui/search_results.rb,
app/components/docs_ui/theme_switcher.rb,
app/components/docs_ui/markdown_action.rb,
app/components/docs_ui/request_example.rb,
app/components/docs_ui/open_api_operation.rb

Overview

The DocsUI namespace is a Phlex::Kit so include DocsUI exposes every component constant as a bare callable method (DocsUI::Shell(), DocsUI::Code(), ...). Named DocsUI (not Docs) so it never collides with a host app's own Views::Docs page namespace, and to match the UI/AdminUI/DocsUI kit convention. Defined before loader.setup so zeitwerk autoloads its children into this already-extended module.

Defined Under Namespace

Modules: PageHelpers Classes: BrandMark, Callout, Code, Endpoint, ErrorTable, Example, FieldTable, Header, Icon, JsonResponse, Landing, Markdown, MarkdownAction, MetaTags, OnThisPage, OpenApiOperation, Page, PropTable, Prose, RequestExample, SearchBox, SearchResults, Section, Shell, Sidebar, Table, ThemeSwitcher, TopbarLinks