Class: DocsUI::Shell

Inherits:

Phlex::HTML

Object
Phlex::HTML
DocsUI::Shell

show all

Includes:: DaisyUI, Phlex::Rails::Helpers::CSPMetaTag, Phlex::Rails::Helpers::CSRFMetaTags, Phlex::Rails::Helpers::ContentSecurityPolicyNonce, Phlex::Rails::Helpers::JavaScriptImportmapTags, Phlex::Rails::Helpers::StylesheetLinkTag

Defined in:: app/components/docs_ui/shell.rb

Overview

The site shell — the full HTML document. A Phlex layout built on the daisyUI Drawer: a sticky topbar, a sidebar always visible on desktop (lg:drawer-open) that toggles as an overlay on mobile, and the page content in a scrollable main. Loads Turbo + (when present) the phlex-reactive Stimulus controller via the importmap tags, and the daisyUI-compiled Tailwind build.

Shell IS the full document, so controllers render the page view with layout: false (see DocsKit::Controller#render_page) to avoid double nesting. phlex-rails still renders through a real view context, so CSRF, dom_id, url helpers, and the reactive token signer all work inside components.

render DocsUI::Shell.new(title: "Installation") { page_body }

Constant Summary collapse

DRAWER_ID =

"site-drawer"

Instance Method Summary collapse

#initialize(title: nil, description: nil, on_page: false) ⇒ Shell constructor
title: the page title → and og:title.</div> </li> <li class="public "> <a href="#view_template-instance_method" title="#view_template (instance method)">#view_template ⇒ Object </a> <div class='inline'></div> </li> </ul> <div id="constructor_details" class="method_details_list"> <h2>Constructor Details</h2> <div class="method_details first"> <h3 class="signature first" id="initialize-instance_method"> #initialize(title: nil, description: nil, on_page: false) ⇒ <tt><a href="" title="DocsUI::Shell (class)">Shell</a></tt> </h3><div class="docstring"> <div class="discussion"> title: the page title → <title> and og:title. description: the page description → the SEO/social meta tags (DocsUI::Page passes its own description or #lead); nil falls back to config.seo.description in DocsUI::MetaTags. on_page: the auto-TOC placement for this page (:panel/:toggle/:sidebar or false). Threaded to the sidebar's docs-nav controller; :panel/:toggle also render an "On this page" slot in the content. </div> </div> <div class="tags"> </div><table class="source_code"> <tr> <td> <pre class="lines"> 33 34 35 36 37</pre> </td> <td> <pre class="code"># File 'app/components/docs_ui/shell.rb', line 33 def initialize(title: nil, description: nil, on_page: false) @title = title @description = description @on_page = <a href="../DocsKit.html" title="DocsKit (module)">DocsKit</a>.<a href="../DocsKit.html#configuration-class_method" title="DocsKit.configuration (method)">configuration</a>.normalize_on_page(on_page) end</pre> </td> </tr> </table> </div> </div> <div id="instance_method_details" class="method_details_list"> <h2>Instance Method Details</h2> <div class="method_details first"> <h3 class="signature first" id="view_template-instance_method"> #view_template ⇒ <tt>Object</tt> </h3><table class="source_code"> <tr> <td> <pre class="lines"> 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58</pre> </td> <td> <pre class="code"># File 'app/components/docs_ui/shell.rb', line 39 def view_template(&) doctype html(lang: "en", data: { theme: config.default_theme }) do render_head # The docs-nav controller lives on <body> — the shared ancestor of BOTH # the sidebar (collapse persistence, :sidebar TOC injection) and the # content column (:panel/:toggle TOC slot + scroll-spy). Scoping it to the # sidebar alone would put the content-column TOC out of its reach. body( class: "bg-base-100 text-base-content", data: { controller: "docs-nav", docs_nav_storage_key_value: config.nav_storage_key, docs_nav_on_page_value: (@on_page || "").to_s } ) do shell(&) end end end</pre> </td> </tr> </table> </div> </div> </div> <div id="footer"> Generated on Sat Jul 4 16:57:21 2026 by <a href="https://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a> 0.9.44 (ruby-4.0.2). </div> </div> </body> </html>