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

Tooltip

Contextual descriptions for Buttons, links, mutation forms, and compound focusable triggers.

Source
app/components/nitro_kit/tooltip.rb
API
NitroKit::Tooltip.new(id:, content:) { |tooltip| tooltip.trigger }

Placements

CSS exposes each description on hover and focus; a tiny controller only adds Escape dismissal.

Placement matrix

Top
This explanation opens on the top edge.
Right
This explanation opens on the right edge.
Bottom
This explanation opens on the bottom edge.
Left
This explanation opens on the left edge.
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/tooltip_page.rb
NitroKit::Tooltip::PLACEMENTS.each do |placement|
  sample(placement.to_s.humanize, slug: placement.to_s) do
    render_tip(
      "gallery-tooltip-#{placement}",
      "This explanation opens on the #{placement} edge.",
      placement:
    )
  end
end

Trigger treatments

Tooltip owns a real Button trigger, including icon-only accessible actions.

Button treatments

Primary
Creates a new production deployment.
Icon only
Copy the account identifier.
Long explanation
Only workspace owners can rotate this credential; active integrations continue using the old value until the rotation completes.
Plain HTML trigger
Deploys pausedDeploys pause while the incident review is open.
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/tooltip_page.rb
sample("Primary", slug: "primary") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-primary",
    content: "Creates a new production deployment."
  ) do |tooltip|
    tooltip.trigger("Deploy", variant: :primary)
  end
end
sample("Icon only", slug: "icon-only") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-icon",
    content: "Copy the account identifier."
  ) do |tooltip|
    tooltip.trigger(
      icon: :copy,
      variant: :ghost,
      size: :sm,
      aria: { label: "Copy account identifier" }
    )
  end
end
sample("Long explanation", slug: "long") do
  render_tip(
    "gallery-tooltip-long",
    "Only workspace owners can rotate this credential; active integrations continue using the old value until the rotation completes."
  )
end
sample("Plain HTML trigger", slug: "html-trigger") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-html",
    content: "Deploys pause while the incident review is open."
  ) do |tooltip|
    tooltip.trigger("Deploys paused", as: :span)
  end
end

Settings composition

A contextual explanation composes beside a sensitive setting without wrapping a raw focus target.

API credential

Production credential

Read and write

nk_live_7P3F… was last used today at 08:31 UTC.

Rotation immediately reveals a new secret once.
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/tooltip_page.rb
render NitroKit::Card.new(id: "gallery-tooltip-api-card") do |card|
  card.title("Production credential", level: 3)
  card.body do
    render NitroKit::Badge.new(
      "Read and write",
      id: "gallery-tooltip-api-access",
      color: :warning,
      size: :sm
    )
    p { "nk_live_7P3F… was last used today at 08:31 UTC." }
  end
  card.footer do
    render NitroKit::Tooltip.new(
      id: "gallery-tooltip-rotate-key",
      content: "Rotation immediately reveals a new secret once."
    ) do |tooltip|
      tooltip.trigger("How rotation works")
    end
    render NitroKit::Button.new(
      "Rotate credential",
      id: "gallery-tooltip-rotate-action",
      variant: :destructive
    )
  end
end

Trigger composition

Links use the Button path directly; mutation forms and compound triggers receive Tooltip-owned attributes explicitly.

Existing actions

Link
Deployment runbookRead the deployment runbook in a new tab.
Rails mutation
Revoking the token immediately rejects new requests.
Dialog trigger

Publish release 2.0?

Review release details before publishing.
Viewport640 px · sm
Rubytest/dummy/app/components/gallery/components/tooltip_page.rb
sample("Link", slug: "link") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-link",
    content: "Read the deployment runbook in a new tab."
  ) do |tooltip|
    tooltip.trigger("Deployment runbook", href: "#runbook", icon_end: :external_link)
  end
end

sample("Rails mutation", slug: "button-to") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-button-to",
    content: "Revoking the token immediately rejects new requests."
  ) do |tooltip|
    tooltip.trigger(as: :custom) do |attributes|
      render NitroKit::ButtonTo.new(
        "Revoke token",
        href: "#revoke-token",
        method: :delete,
        variant: :destructive,
        button_html: attributes.html,
        button_aria: attributes.aria,
        button_data: attributes.data
      )
    end
  end
end

sample("Dialog trigger", slug: "dialog") do
  render NitroKit::Tooltip.new(
    id: "gallery-tooltip-dialog",
    content: "Review release details before publishing."
  ) do |tooltip|
    tooltip.trigger(as: :custom) do |attributes|
      render NitroKit::Dialog.new(id: "gallery-tooltip-release-dialog") do |dialog|
        dialog.trigger(
          "Review release",
          html: attributes.html,
          aria: attributes.aria,
          data: attributes.data
        )
        dialog.panel(title: "Publish release 2.0?") do
          dialog.close_button(label: "Keep as draft")
        end
      end
    end
  end
end

Component contract

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

docs/component_contracts.md · NitroKit::Tooltip

Constructor-specific options
  • required id:, content:
  • placement: :top
Root and closed vocabulary
span[data-nk=tooltip]; placements top right bottom left
Compound contract
Requires exactly one trigger. The default as: NitroKit::Button path supports native buttons and links; Button options on any other trigger raise. as: :div and :span create explicit focusable HTML descriptions. as: :custom yields TriggerAttributes(html:, aria:, data:); applications must forward all three boundaries to the actual focusable control, including ButtonTo's nested Button or a Dialog trigger. Nitro appends the tooltip ID to existing aria-describedby. CSS owns hover/focus visibility; the controller's document-level Escape listener dismisses only while the tooltip is shown, so a wrapping dialog's cancel is not swallowed.

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.