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

Empty state

An explicit empty result with controlled heading hierarchy, icon, and up to two actions.

Source
EmptyState is content, not application policy: callers choose copy, destinations, and whether zero, one, or two actions are appropriate.
API
Supply the required title through title: or title { ... }; description supports the same two forms. variant: accepts :default or :borderless and level: accepts 2..6. icon accepts one Icon and action accepts at most two distinct Buttons.

Presentation

variant: is a closed vocabulary of default and borderless; any other value raises ArgumentError. The dashed default frames a standalone region and deliberately resembles a drop target, so prefer borderless whenever a Card, DataSection, table, or dialog already draws the frame — and never place the dashed default next to a real Dropzone.

Variant matrix

Default

No saved views

The dashed frame marks an otherwise unframed region of the page.

Borderless

No saved views

Inside a frame of its own, the empty state drops its border and fill.

Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
sample("Default", slug: "default") do
  render NitroKit::EmptyState.new(
    title: "No saved views",
    description: "The dashed frame marks an otherwise unframed region of the page.",
    id: "gallery-empty-state-variant-default"
  ) do |empty|
    empty.icon NitroKit::Icon.new(:layout_grid)
  end
end
sample("Borderless", slug: "borderless") do
  render NitroKit::EmptyState.new(
    title: "No saved views",
    description: "Inside a frame of its own, the empty state drops its border and fill.",
    variant: :borderless,
    id: "gallery-empty-state-variant-borderless"
  ) do |empty|
    empty.icon NitroKit::Icon.new(:layout_grid)
  end
end

Borderless inside a card

The card owns the surface and border, so a dashed empty state inside it would read as a second, droppable surface.

Recent deployments

No deployments this week

Promote a release to see it listed here.

Promote a release
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::Card.new(id: "gallery-empty-state-card") do |card|
  card.title("Recent deployments", level: 3)
  card.body do
    render NitroKit::EmptyState.new(
      title: "No deployments this week",
      description: "Promote a release to see it listed here.",
      variant: :borderless,
      level: 4,
      id: "gallery-empty-state-in-card"
    ) do |empty|
      empty.icon NitroKit::Icon.new(:rocket)
      empty.action NitroKit::Button.new("Promote a release", href: "#promote", variant: :primary)
    end
  end
end

Optional content and actions

Heading levels, optional icon and description, and zero through two typed actions.

Title only

No records

Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::EmptyState.new(title: "No records", id: "gallery-empty-state-title-only")

Informational

No API activity yet

Requests will appear after a credential makes its first call.

Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::EmptyState.new(
  title: "No API activity yet",
  description: "Requests will appear after a credential makes its first call.",
  id: "gallery-empty-state-information"
) do |empty|
  empty.icon NitroKit::Icon.new(:activity)
end

Primary action

No teammates yet

Invite the first collaborator when the workspace is ready.

Invite teammate
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::EmptyState.new(
  title: "No teammates yet",
  description: "Invite the first collaborator when the workspace is ready.",
  id: "gallery-empty-state-one-action"
) do |empty|
  empty.icon NitroKit::Icon.new(:users)
  empty.action NitroKit::Button.new("Invite teammate", href: "#invite", variant: :primary)
end

Primary and escape actions

No matching invoices

Change the date range or clear every filter to return to invoice history.

Clear filtersReturn to billing
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::EmptyState.new(
  title: "No matching invoices",
  description: "Change the date range or clear every filter to return to invoice history.",
  id: "gallery-empty-state-two-actions"
) do |empty|
  empty.icon NitroKit::Icon.new(:search_x)
  empty.action NitroKit::Button.new("Clear filters", href: "#clear", variant: :primary)
  empty.action NitroKit::Button.new("Return to billing", href: "#billing")
end

Long nested empty state

No records for International Research, Production, and Reliability Engineering

The current search includes archived projects, suspended members, expired credentials, and a date range that predates this workspace. Remove one or more filters before trying again.

Reset all filtersReview query guide
ViewportFull width
Rubytest/dummy/app/components/gallery/components/empty_state_page.rb
render NitroKit::Container.new(size: :md, id: "gallery-empty-state-long-container") do
  render NitroKit::EmptyState.new(
    level: 4,
    id: "gallery-empty-state-long"
  ) do |empty|
    empty.title do
      plain "No records for "
      strong { "International Research, Production, and Reliability Engineering" }
    end
    empty.description do
      plain "The current search includes archived projects, suspended members, expired credentials, and a date range that predates this workspace. "
      plain "Remove one or more filters before trying again."
    end
    empty.icon NitroKit::Icon.new(:database)
    empty.action NitroKit::Button.new("Reset all filters", href: "#reset", variant: :primary)
    empty.action NitroKit::Button.new("Review query guide", href: "#guide")
  end
end

Component contract

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

docs/component_contracts.md · NitroKit::EmptyState

Constructor
title: nil, description: nil, variant: :default, level: 2, id: nil
Root
section[data-nk=empty-state][data-variant]; variants default borderless
Compound contract
Requires title; title and description each accept constructor text or one matching text/rich-content compound declaration. Heading levels 2..6; at most one Icon and two distinct Button actions. default draws the dashed frame for a standalone region; borderless drops frame and fill for a region a Card, DataSection, or table already encloses, where the dashed frame would read as a Dropzone. Declaring a compound method outside the render block raises.

Relevant patterns

Application conventions this component belongs to. Each summary is the leading section of its pattern document.

docs/patterns/crud_resource.md

Complete product resource

  • Define the resource, tenant boundary, actor, lifecycle, visibility, and states before writing views.
  • Build index, form, detail, destructive action, and tests as one product surface.
  • Use one shell toolbar title and one application-owned page gutter; do not repeat hierarchy across nested components.
  • Scope every lookup through the current tenant and model meaningful lifecycle transitions as noun resources.

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.