Skip to content
Nitro Kitv2.0.0.alpha.4

Search gallery…

IntroductionGalleryAgent guideGalleryHuman guideGalleryColorsFoundations · ThemeTypographyFoundations · ThemeSpacing & sizingFoundations · ThemeEffectsFoundations · ThemeButtonComponents · ActionsButton groupComponents · ActionsButton toComponents · ActionsAppearance pickerComponents · FormsCheckboxComponents · FormsCheckbox groupComponents · FormsComboboxComponents · FormsControl groupComponents · FormsDropzoneComponents · FormsFieldComponents · FormsField groupComponents · FormsFieldsetComponents · FormsInputComponents · FormsLabelComponents · FormsRadio buttonComponents · FormsRadio button groupComponents · FormsRich text areaComponents · FormsSelectComponents · FormsSwitchComponents · FormsTextareaComponents · FormsCommand paletteComponents · OverlaysDialogComponents · OverlaysDropdownComponents · OverlaysSheetComponents · OverlaysTooltipComponents · OverlaysAlertComponents · FeedbackEmpty stateComponents · FeedbackToastComponents · FeedbackAccordionComponents · Data displayAvatarComponents · Data displayAvatar stackComponents · Data displayBadgeComponents · Data displayDetails tableComponents · Data displayIconComponents · Data displayProgressive imageComponents · Data displayStat gridComponents · Data displayTableComponents · Data displayTypesetComponents · Data displayPaginationComponents · NavigationPagination barComponents · NavigationTabsComponents · NavigationToolbarComponents · NavigationCardComponents · LayoutContainerComponents · LayoutFlexComponents · LayoutGridComponents · LayoutApplication navigationComponents · ApplicationApplication shellComponents · ApplicationAuthentication shellComponents · ApplicationDanger zoneComponents · ApplicationData sectionComponents · ApplicationForm sectionComponents · ApplicationPage headerComponents · ApplicationSettings layoutComponents · ApplicationSign inCompositions · Access & onboardingPassword resetCompositions · Access & onboardingEmail verificationCompositions · Access & onboardingInvitation acceptanceCompositions · Access & onboardingAccount creationCompositions · Access & onboardingAccount securityCompositions · Access & onboardingWorkspace onboardingCompositions · Access & onboardingBranched onboardingCompositions · Access & onboardingWorkspace dashboardCompositions · Workspace & organizationWorkspace settingsCompositions · Workspace & organizationWorkspace usersCompositions · Workspace & organizationTeam managementCompositions · Workspace & organizationAPI credentialsCompositions · Workspace & organizationOrganization overviewCompositions · Workspace & organizationOrganization settingsCompositions · Workspace & organizationTeam activityCompositions · Workspace & organizationTeam memberCompositions · Workspace & organizationSubscription billingCompositions · Billing & commerceCheckout and paymentCompositions · Billing & commerceCheckout resultsCompositions · Billing & commerceData resource overviewCompositions · Data & operationsData resource activityCompositions · Data & operationsData resource settingsCompositions · Data & operationsProduct resource lifecycleCompositions · Data & operationsAPI webhooksCompositions · Data & operationsIntegration managementCompositions · Data & operationsFile uploadsCompositions · Data & operationsActivity and audit logCompositions · Data & operationsChangelogCompositions · Product & supportHelp centerCompositions · Product & supportSystem status and errorsCompositions · Product & supportProduct landingCompositions · MarketingPublic pricingCompositions · MarketingProduct featuresCompositions · MarketingPublic contactCompositions · MarketingSidebar operations applicationCompositions · Complete applicationsTopbar media applicationCompositions · Complete applicationsHybrid account applicationCompositions · Complete applications

No destinations found.

  • Introduction
  • Agent guide
  • Human guide
  • Foundations
    • Colors
    • Typography
    • Spacing & sizing
    • Effects
  • Actions
    • Button
    • Button group
    • Button to
  • Forms
    • Appearance picker
    • Checkbox
    • Checkbox group
    • Combobox
    • Control group
    • Dropzone
    • Field
    • Field group
    • Fieldset
    • Input
    • Label
    • Radio button
    • Radio button group
    • Rich text area
    • Select
    • Switch
    • Textarea
  • Overlays
    • Command palette
    • Dialog
    • Dropdown
    • Sheet
    • Tooltip
  • Feedback
    • Alert
    • Empty state
    • Toast
  • Data display
    • Accordion
    • Avatar
    • Avatar stack
    • Badge
    • Details table
    • Icon
    • Progressive image
    • Stat grid
    • Table
    • Typeset
  • Navigation
    • Pagination
    • Pagination bar
    • Tabs
    • Toolbar
  • Layout
    • Card
    • Container
    • Flex
    • Grid
  • Application
    • Application navigation
    • Application shell
    • Authentication shell
    • Danger zone
    • Data section
    • Form section
    • Page header
    • Settings layout
  • Access & onboarding
    • Sign in
    • Password reset
    • Email verification
    • Invitation acceptance
    • Account creation
    • Account security
    • Workspace onboarding
    • Branched onboarding
  • Workspace & organization
    • Workspace dashboard
    • Workspace settings
    • Workspace users
    • Team management
    • API credentials
    • Organization overview
    • Organization settings
    • Team activity
    • Team member
  • Billing & commerce
    • Subscription billing
    • Checkout and payment
    • Checkout results
  • Data & operations
    • Data resource overview
    • Data resource activity
    • Data resource settings
    • Product resource lifecycle
    • API webhooks
    • Integration management
    • File uploads
    • Activity and audit log
  • Product & support
    • Changelog
    • Help center
    • System status and errors
  • Marketing
    • Product landing
    • Public pricing
    • Product features
    • Public contact
  • Complete applications
    • Sidebar operations application
    • Topbar media application
    • Hybrid account application

Sheet

A native modal side panel for narrow navigation and contextual details.

Source
app/components/nitro_kit/sheet.rb
API
NitroKit::Sheet.new(id:, side:, size:) { |sheet| sheet.trigger; sheet.panel }

Side panels

A native modal dialog enters from either inline edge without changing surrounding flex or grid layout.

Navigation and details

Transcript prompts

Jump to a prompt in this transcript.

  • Set up the project
  • Review the implementation
  • Prepare the release

Deployment 1842

Production release details

EnvironmentProduction
StatusRunning
OwnerAda Lovelace
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/sheet_page.rb
prompts = [
  [ "Set up the project", "#prompt-1" ],
  [ "Review the implementation", "#prompt-2" ],
  [ "Prepare the release", "#prompt-3" ]
]

render NitroKit::Sheet.new(id: "gallery-sheet-prompts", side: :left, size: :sm) do |sheet|
  sheet.trigger("Prompts", icon: :list)
  sheet.panel(
    title: "Transcript prompts",
    description: "Jump to a prompt in this transcript."
  ) do
    render NitroKit::AppNavigation.new(label: "Transcript prompts") do |navigation|
      navigation.body do |items|
        prompts.each_with_index do |(text, href), index|
          items.item(text, href:, current: index.zero?)
        end
      end
    end
  end
end

render NitroKit::Sheet.new(id: "gallery-sheet-details", side: :right, size: :md) do |sheet|
  sheet.trigger("Record details", icon_end: :panel_right)
  sheet.panel(title: "Deployment 1842", description: "Production release details") do
    render NitroKit::DetailsTable.new(
      Deployment.new(environment: "Production", status: "Running", owner: "Ada Lovelace"),
      label: "Deployment details"
    ) do |details|
      details.fields(:environment, :status, :owner)
    end
  end
end

Sizes, long content, and unavailable

A large sheet scrolls long content past its sticky close control with a custom close label; a disabled trigger keeps the panel unreachable.

Release changelog

Every change since the previous production deploy.

Change 1. Deploy 1830 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 2. Deploy 1831 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 3. Deploy 1832 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 4. Deploy 1833 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 5. Deploy 1834 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 6. Deploy 1835 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 7. Deploy 1836 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 8. Deploy 1837 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 9. Deploy 1838 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 10. Deploy 1839 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 11. Deploy 1840 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Change 12. Deploy 1841 refreshed the ingestion pipeline, rotated its credentials, and re-ran the archived backfill verification for every affected workspace.

Deployment details

Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/sheet_page.rb
render NitroKit::Sheet.new(
  id: "gallery-sheet-long",
  side: :right,
  size: :lg,
  close_label: "Close changelog"
) do |sheet|
  sheet.trigger("Full changelog")
  sheet.panel(
    title: "Release changelog",
    description: "Every change since the previous production deploy."
  ) do
    12.times do |index|
      p do
        "Change #{index + 1}. Deploy #{1830 + index} refreshed the ingestion " \
          "pipeline, rotated its credentials, and re-ran the archived backfill " \
          "verification for every affected workspace."
      end
    end
  end
end

render NitroKit::Sheet.new(id: "gallery-sheet-disabled", side: :right, size: :sm) do |sheet|
  sheet.trigger("Deployment details", disabled: true)
  sheet.panel(title: "Deployment details")
end

Component contract

Constructor options, rendered root, closed vocabularies, and compound boundary for this component, exactly as shipped.

docs/component_contracts.md · NitroKit::Sheet

Constructor-specific options
  • required id:
  • side: :right, size: :md, close_label:
Root and closed vocabulary
layout-transparent div[data-nk=sheet][data-side][data-size] owning one native dialog; sides left right; sizes sm md lg
Compound contract
Requires exactly one Button-backed trigger and one panel(title:, description: nil); both carry the shared html:, aria:, data:, and desperately_need_a_class: boundary, panel attributes landing on the dialog element as in Dialog. The native modal panel fills the block axis and enters from the selected inline edge. Nitro owns close, title, description, body order, backdrop dismissal, and native focus containment. Use Sheet for contextual narrow navigation or details; use AppShell for whole-application navigation and Dialog for centered decisions.

System rules for coding agents

Instructions for coding agents, repeated on every component page so one fetched page has enough context. Humans can usually skip this section.

test/dummy/app/components/gallery/agent_rules.rb

View agent instructions
  • Nitro Kit 2.0 is a gem-owned, Phlex-only UI system for Rails. Render components directly: render NitroKit::Button.new("Save", variant: :primary).
  • Compose Nitro components inside application-owned Phlex classes. Public initializers and declared slots are the component API; private methods are not.
  • Public options are explicit keywords, and enumerated options are closed vocabularies. Invalid names or values raise ArgumentError; this component's accepted options are in the contract above.
  • Pass native attributes through their typed boundary: html: for HTML, aria: for ARIA, and data: for application data. class and style are forbidden, including inside html:.
  • Nitro owns NitroKit::Component::RESERVED_DATA_ATTRIBUTES: data-nk, data-slot, data-variant, data-size, data-nk-escape, data-enhanced, data-state, data-disabled, data-required, data-orientation, data-presentation, data-placement, data-layout, data-side, data-field-type, data-dir, data-gap, data-align, data-justify, data-wrap, data-cols, data-mode, data-key. Do not pass them through data:. data-action, data-controller are additive and compose with Nitro behavior.
  • If an integration truly requires a class, use desperately_need_a_class:. It requires a non-blank String and marks the exception with data-nk-escape="class".
  • Every root emits data-nk; owned parts emit component-qualified data-slot values such as field-control or card-title. Select on those attributes, never on classes.
  • Customize components with documented --nk-* custom properties in an application stylesheet. Variables beginning with --_nk-* are private component mechanics.
  • Use NitroKit::Flex and NitroKit::Grid for layout. Parents own external placement and available width; components own their intrinsic geometry.
  • Preserve native elements and accessibility semantics. State is exposed through native semantics and ARIA first, and through data-state when styling or behavior also needs it.