slintcn

https://zero-sq.github.io/slintcn/docs
Admin
slintcn is a copy-paste UI component collection and CLI for Slint that provides customizable native...
Tokens:25,280
Snippets:532
Trust Score:9.7
Update:1 month ago
Show doc for...
Tokens:
Raw
### Installation

Source: https://zero-sq.github.io/slintcn/docs/dropdown-menu.html

Command to install the DropdownMenu component using the slintcn CLI.

```APIDOC
## Installation

### Command
`cargo slintcn add dropdown-menu`
```

--------------------------------

### Install Pricing block with bun

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Install the Pricing block using bun.

```bash
bun slintcn add pricing
```

--------------------------------

### Install Pricing block with yarn

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Install the Pricing block using yarn.

```bash
yarn slintcn add pricing
```

--------------------------------

### Install DropdownMenu with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/dropdown-menu.html

Install the dropdown-menu component using the cargo slintcn add command. This is the recommended installation method.

```bash
cargo slintcn add dropdown-menu
```

--------------------------------

### Install SheetPanel with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/sheet-panel.html

Install the sheet-panel component using the cargo command. This is the primary installation method shown.

```bash
cargo slintcn add sheet-panel
```

--------------------------------

### Install Pricing block with npm

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Install the Pricing block using npm.

```bash
npm slintcn add pricing
```

--------------------------------

### Install Pricing block with pnpm

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Install the Pricing block using pnpm.

```bash
pnpm slintcn add pricing
```

--------------------------------

### Install Button with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/button.html

Install the button component using the cargo command. This is the primary installation method shown.

```bash
cargo slintcn add button
```

--------------------------------

### Install DatePicker with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/date-picker.html

Command to install the date-picker component using the slintcn CLI. This is the recommended installation method.

```bash
cargo slintcn add date-picker
```

--------------------------------

### Install Pricing block with cargo

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Install the Pricing block using the cargo command.

```bash
cargo slintcn add pricing
```

--------------------------------

### Install Menubar with cargo

Source: https://zero-sq.github.io/slintcn/docs/menubar.html

Install the menubar component using the cargo command.

```bash
cargo slintcn add menubar
```

--------------------------------

### Install Badge with bun

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Install the Badge component using the bun package manager.

```bash
bun slintcn add badge
```

--------------------------------

### Installation with cargo slintcn add label

Source: https://zero-sq.github.io/slintcn/docs/label.html

Install the Label component using the `cargo slintcn add label` command. The command installs theme as a transitive dependency.

```bash
cargo slintcn add label
```

--------------------------------

### Install Keycap with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/keycap.html

Installs the Keycap component via the SlintCN CLI. The command is available in the Installation section and is the recommended way to add the component.

```bash
cargo slintcn add keycap
```

--------------------------------

### Usage example for Command component in Slint

Source: https://zero-sq.github.io/slintcn/docs/command.html

Example showing how to import and use the Command component in a Slint file. Mount it as the last child of Window so the backdrop covers everything. The example demonstrates two-way bindings for open and query, and the selected callback.

```slint
import { Command, CommandItem } from "slintcn/components/command.slint";

// Mount as the LAST child of Window so the backdrop covers everything.
Command {
    width: parent.width;
    height: parent.height;
    open <=> palette-open;
    items: [
        { label: "New file",   id: "file.new",   hint: "⌘N" },
        { label: "Open file…", id: "file.open",  hint: "⌘O" },
        { label: "Save",       id: "file.save",  hint: "⌘S" },
    ];
    query <=> query;
    selected(id) => { /* dispatch by id */ }
}
```

--------------------------------

### Install Card with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/card.html

Install the Card component using the cargo CLI command.

```bash
cargo slintcn add card
```

--------------------------------

### Install Badge with pnpm

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Install the Badge component using the pnpm package manager.

```bash
pnpm slintcn add badge
```

--------------------------------

### Install Text component with pnpm

Source: https://zero-sq.github.io/slintcn/docs/text.html

Install the Text component using the pnpm package manager.

```bash
pnpm
```

--------------------------------

### Install Sidebar with cargo slintcn add sidebar

Source: https://zero-sq.github.io/slintcn/docs/sidebar.html

Install the Sidebar component using the cargo command. This is the primary installation method for Rust projects.

```bash
cargo slintcn add sidebar
```

--------------------------------

### Install components with slintcn add using namespace or direct URL

Source: https://zero-sq.github.io/slintcn/docs/directory.html

Install components from a custom registry using the namespace prefix or a direct URL. The direct URL form bypasses the registry configuration.

```bash
slintcn add @acme/button-pro
slintcn add https://example.com/registry/r/special.json   # direct URL also works
```

--------------------------------

### Install Tabs component with bun

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Install the Tabs component using the bun package manager.

```bash
bun slintcn add tabs
```

--------------------------------

### Install Badge with yarn

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Install the Badge component using the yarn package manager.

```bash
yarn slintcn add badge
```

--------------------------------

### Install Badge with npm

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Install the Badge component using the npm package manager.

```bash
npm slintcn add badge
```

--------------------------------

### Install Hover Card with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/hover-card.html

Install the Hover Card component using the `cargo slintcn add hover-card` command. This is the installation method for the Cargo package manager.

```bash
cargo slintcn add hover-card
```

--------------------------------

### Install Text component with yarn

Source: https://zero-sq.github.io/slintcn/docs/text.html

Install the Text component using the yarn package manager.

```bash
yarn
```

--------------------------------

### Usage example for Badge component

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Shows how to import and use the Badge component in a Slint file. The example creates a Badge with text "New" and the default variant.

```slint
import { Badge, BadgeVariant } from "slintcn/components/badge.slint";

Badge { text: "New"; variant: BadgeVariant.default; }
```

--------------------------------

### Install Command component with cargo slintcn add command

Source: https://zero-sq.github.io/slintcn/docs/command.html

Install the Command component using the cargo package manager. This is the primary installation command for the slintcn CLI.

```bash
cargo slintcn add command
```

--------------------------------

### Install CompassStrip with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/compass-strip.html

Install the compass-strip component using the cargo package manager.

```bash
cargo slintcn add compass-strip
```

--------------------------------

### Install Text component with npm

Source: https://zero-sq.github.io/slintcn/docs/text.html

Install the Text component using the npm package manager.

```bash
npm
```

--------------------------------

### Install Badge with cargo

Source: https://zero-sq.github.io/slintcn/docs/badge.html

Install the Badge component using the cargo package manager.

```bash
cargo slintcn add badge
```

--------------------------------

### Usage example for Text component

Source: https://zero-sq.github.io/slintcn/docs/text.html

Shows how to import the Text component and use it with different variants and tones.

```slint
// alias to avoid shadowing the built-in Text:
import { Text as Typography, TextVariant, TextTone } from "slintcn/components/text.slint";

Typography { text: "Display"; variant: TextVariant.display; }
Typography { text: "Muted body"; variant: TextVariant.body; tone: TextTone.muted; }
```

--------------------------------

### Install Text component with cargo

Source: https://zero-sq.github.io/slintcn/docs/text.html

Install the Text component using the cargo package manager.

```bash
cargo slintcn add text
```

--------------------------------

### Install Settings block with cargo

Source: https://zero-sq.github.io/slintcn/docs/settings.html

Install the Settings block using the SlintCN CLI. This command adds the block and its dependencies automatically.

```bash
cargo slintcn add settings
```

--------------------------------

### Install aspect-ratio component with package manager

Source: https://zero-sq.github.io/slintcn/docs/aspect-ratio.html

Install the aspect-ratio component using your package manager. The command is run in the project root and adds the component as a dependency.

```bash
cargo slintcn add aspect-ratio
```

```bash
npm slintcn add aspect-ratio
```

```bash
pnpm slintcn add aspect-ratio
```

```bash
yarn slintcn add aspect-ratio
```

```bash
bun slintcn add aspect-ratio
```

--------------------------------

### Install slintcn via cargo

Source: https://zero-sq.github.io/slintcn

Install the slintcn CLI using cargo. This is the recommended method for Rust users without Node.

```bash
$ cargo install slintcn
```

--------------------------------

### Usage example for Pricing block

Source: https://zero-sq.github.io/slintcn/docs/pricing.html

Import the Pricing component and use it with the 'chosen' property and 'pick' callback.

```slint
import { Pricing } from "slintcn/blocks/pricing.slint";

Pricing { chosen: 1; pick(i) => { /* … */ } }
```

--------------------------------

### Install Dashboard component

Source: https://zero-sq.github.io/slintcn/docs/dashboard.html

Use the CLI to add the dashboard block to your project.

```bash
cargo slintcn add dashboard
```

--------------------------------

### Install Tabs component with pnpm

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Install the Tabs component using the pnpm package manager.

```bash
pnpm slintcn add tabs
```

--------------------------------

### Install context-menu with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/context-menu.html

Install the context-menu component using the SlintCN CLI. This command adds the component and its theme dependency automatically.

```bash
cargo slintcn add context-menu
```

--------------------------------

### Install Progress component

Source: https://zero-sq.github.io/slintcn/docs/progress.html

Use the package manager command to add the progress component to your project.

```bash
cargo slintcn add progress
```

--------------------------------

### Usage example

Source: https://zero-sq.github.io/slintcn/docs/checkbox.html

Example of importing and using the Checkbox component with a two-way bound `checked` property.

```slint
import { Checkbox } from "slintcn/components/checkbox.slint";

Checkbox { label: "Accept terms"; checked <=> accepted; }
```

--------------------------------

### Install Tabs component with npm

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Install the Tabs component using the npm package manager.

```bash
npm slintcn add tabs
```

--------------------------------

### Install Tabs component with yarn

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Install the Tabs component using the yarn package manager.

```bash
yarn slintcn add tabs
```

--------------------------------

### Install Input component via Cargo

Source: https://zero-sq.github.io/slintcn/docs/input.html

Installs the input component as a dependency using Cargo, making focus-ring available as a transitive dependency.

```bash
cargo slintcn add input
```

--------------------------------

### Install Stats block with cargo

Source: https://zero-sq.github.io/slintcn/docs/stats.html

Install the Stats block using the Cargo package manager. Run this command in your project directory.

```bash
cargo slintcn add stats
```

--------------------------------

### Usage

Source: https://zero-sq.github.io/slintcn/docs/dropdown-menu.html

Example of importing and using the DropdownMenu component in a Slint file.

```APIDOC
## Usage

### Import
```
import { DropdownMenu, DropdownMenuItem } from "slintcn/components/dropdown-menu.slint";
```

### Example
```
DropdownMenu {
    items: [{ label: "Profile" }, { label: "Billing" }, { label: "Sign out" }];
    selected(i) => { /* … */ }
    Button { text: "Open menu"; }   // trigger = @children
}
```
```

--------------------------------

### Installation command

Source: https://zero-sq.github.io/slintcn/docs/checkbox.html

Command to add the Checkbox component to a Slint project.

```bash
cargo slintcn add checkbox
```

--------------------------------

### Install Toast component with cargo slintcn add toast

Source: https://zero-sq.github.io/slintcn/docs/toast.html

Install the Toast component using the cargo command. The command is `cargo slintcn add toast`.

```bash
cargo slintcn add toast
```

--------------------------------

### Install Skeleton with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/skeleton.html

Install the Skeleton component using the slintcn CLI. This command adds the component and its theme dependency automatically.

```bash
cargo slintcn add skeleton
```

--------------------------------

### Install Tabs component with cargo

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Install the Tabs component using the cargo package manager.

```bash
cargo slintcn add tabs
```

--------------------------------

### Install Toggle component

Source: https://zero-sq.github.io/slintcn/docs/toggle.html

Use the package manager command to add the toggle component to your project.

```shell
cargo slintcn add toggle
```

--------------------------------

### Install navigation-menu with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/navigation-menu.html

Install the navigation-menu component using the SlintCN CLI. Run this command in your project directory to add the component and its theme dependency automatically.

```bash
cargo slintcn add navigation-menu
```

--------------------------------

### Install Hotbar with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/hotbar.html

Install the Hotbar component using the SlintCN CLI. This command adds the component and its transitive dependencies automatically.

```bash
cargo slintcn add hotbar
```

--------------------------------

### Install Collapsible with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/collapsible.html

Install the Collapsible component using the cargo package manager. The command is `cargo slintcn add collapsible`.

```bash
cargo slintcn add collapsible
```

--------------------------------

### Install Textarea with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/textarea.html

Install the Textarea component using the cargo package manager. This command adds the component and its transitive dependencies, including focus-ring.

```bash
cargo slintcn add textarea
```

--------------------------------

### Install popover with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/popover.html

Install the popover component using the SlintCN CLI. This command adds the component and its theme dependency automatically.

```bash
cargo slintcn add popover
```

--------------------------------

### Usage example for Sidebar component

Source: https://zero-sq.github.io/slintcn/docs/sidebar.html

Example showing how to import and use the Sidebar component in a Slint file. It defines items with labels and icons, binds active and collapsed properties, and handles navigation.

```slint
import { Sidebar, SidebarItem } from "slintcn/components/sidebar.slint";
import { LucidePaths } from "slintcn/components/lucide-paths.slint";

Sidebar {
    items: [
        { label: "Overview",  id: "home",     icon: LucidePaths.dot },
        { label: "Customers", id: "people",   icon: LucidePaths.dot },
        { label: "Settings",  id: "settings", icon: LucidePaths.dot },
    ];
    active <=> route;
    collapsed <=> nav-collapsed;
    navigate(id) => { /* route to id */ }
}
```

--------------------------------

### Import and use Keycap component

Source: https://zero-sq.github.io/slintcn/docs/keycap.html

Imports the Keycap component and its enums, then instantiates a Keycap with a text label and a tone. The example uses the on-glass tone.

```slint
import { Keycap, KeycapSize, KeycapTone } from "slintcn/components/keycap.slint";

Keycap { text: "⌘"; tone: KeycapTone.on-glass; }
```

--------------------------------

### Install data-table with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/data-table.html

Adds the data-table component to a Slint project using Cargo. This is the installation command for the data-table component.

```bash
cargo slintcn add data-table
```

--------------------------------

### Install Combobox with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/combobox.html

Install the Combobox component using the cargo package manager. This command adds the component and its transitive dependencies automatically.

```bash
cargo slintcn add combobox
```

--------------------------------

### Install accordion with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/accordion.html

Install the accordion component using the SlintCN CLI. Run this command in your project directory to add the accordion component and its transitive dependencies (icon, lucide-paths, separator) automatically.

```bash
cargo slintcn add accordion
```

--------------------------------

### Add a component with cargo slintcn add

Source: https://zero-sq.github.io/slintcn

Install a component from the registry using the cargo CLI. The command copies .slint source into your project and rewrites imports.

```bash
$`cargo slintcn add button` copy
```

--------------------------------

### Install Table component with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/table.html

Installs the Table component using the cargo package manager. This command adds the component and its transitive dependencies.

```bash
cargo slintcn add table
```

--------------------------------

### Install Avatar with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/avatar.html

Install the Avatar component using the slintcn CLI. This command adds the component and its transitive dependencies (theme only).

```bash
cargo slintcn add avatar
```

--------------------------------

### Install login block with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/login.html

Install the login block using the SlintCN CLI. This command adds the block and its transitive dependencies (card, input, label, button, separator) automatically.

```bash
cargo slintcn add login
```

--------------------------------

### Install Switch with cargo slintcn add switch

Source: https://zero-sq.github.io/slintcn/docs/switch.html

Install the Switch component using the SlintCN CLI. This command adds the switch component and its transitive dependency focus-ring automatically.

```bash
cargo slintcn add switch
```

--------------------------------

### Usage example for Tabs component

Source: https://zero-sq.github.io/slintcn/docs/tabs.html

Example showing how to import and use the Tabs component in a Slint file. It defines two tabs and binds the current index to a variable, with a conditional comment for content.

```slint
import { Tabs, TabsVariant } from "slintcn/components/tabs.slint";

Tabs {
    items: [{ label: "Account" }, { label: "Password" }];
    current <=> tab;
}
if tab == 0: /* Account content */
```

--------------------------------

### Install Profile component via Cargo

Source: https://zero-sq.github.io/slintcn/docs/profile.html

Use the cargo command to add the profile block to your project.

```bash
cargo slintcn add profile
```

--------------------------------

### Install Icon component with cargo slintcn add icon

Source: https://zero-sq.github.io/slintcn/docs/icon.html

Install the Icon component using the slintcn CLI. This command adds the component and its transitive dependencies (theme only).

```bash
cargo slintcn add icon
```

--------------------------------

### Install Separator with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/separator.html

Install the Separator component using the Cargo package manager. This command adds the separator component and its theme dependency automatically.

```bash
cargo slintcn add separator
```

--------------------------------

### Import and use Card component in Slint

Source: https://zero-sq.github.io/slintcn/docs/card.html

Example of importing the Card component and using it with a solid variant and a vertical layout for content.

```slint
import { Card, CardVariant } from "slintcn/components/card.slint";

Card {
    variant: CardVariant.solid;
    VerticalLayout {
        padding: parent.padding-l;
        spacing: parent.gap-l;
        // your content
    }
}
```

--------------------------------

### Install dialog with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/dialog.html

Command to add the dialog component to a Slint project.

```bash
cargo slintcn add dialog
```

--------------------------------

### Initialize and add components with cargo slintcn

Source: https://zero-sq.github.io/slintcn

Initialize a slintcn project and add components (button, card, dialog) using the cargo CLI. Files land in ui/slintcn/.

```bash
$ cargo slintcn init
```

```bash
$ cargo slintcn add button card dialog
```

--------------------------------

### Install with cargo slintcn add pagination

Source: https://zero-sq.github.io/slintcn/docs/pagination.html

Command to add the pagination component to a project using the slintcn CLI.

```bash
cargo slintcn add pagination
```

--------------------------------

### Use Icon component with LucidePaths.check

Source: https://zero-sq.github.io/slintcn/docs/icon.html

Import the Icon component and LucidePaths, then instantiate Icon with a LucidePaths command, size, and tint. The tint defaults to the foreground token.

```slint
import { Icon } from "slintcn/components/icon.slint";
import { LucidePaths } from "slintcn/components/lucide-paths.slint";

Icon { commands: LucidePaths.check; size: 20px; tint: Tokens.color-foreground; }
```

--------------------------------

### Installation: cargo slintcn add radio-group

Source: https://zero-sq.github.io/slintcn/docs/radio-group.html

Command to install the radio-group component using Cargo.

```bash
cargo slintcn add radio-group
```

--------------------------------

### cargo slintcn add sheet

Source: https://zero-sq.github.io/slintcn/docs/sheet.html

Command to install the Sheet component. Shown in the Installation tab as the package manager command (cargo).

```bash
cargo slintcn add sheet
```

--------------------------------

### Install Breadcrumb with Cargo

Source: https://zero-sq.github.io/slintcn/docs/breadcrumb.html

Adds the Breadcrumb component to a Slint project using Cargo. This is the installation command for the Rust package manager.

```bash
cargo slintcn add breadcrumb
```

--------------------------------

### Usage example for Alert component

Source: https://zero-sq.github.io/slintcn/docs/alert.html

Shows how to use the Alert component in Slint. Import Alert, AlertVariant, and LucidePaths, then instantiate Alert with icon, title, and description properties.

```slint
import { Alert, AlertVariant } from "slintcn/components/alert.slint";
import { LucidePaths } from "slintcn/components/lucide-paths.slint";

Alert {
    icon: LucidePaths.check;
    title: "Deployed";
    description: "Your changes are live.";
}
```

--------------------------------

### Input component usage example

Source: https://zero-sq.github.io/slintcn/docs/input.html

Import the Input component and use it with a placeholder, a two-way text binding to email, and an edited callback that fires on every keystroke.

```slint
import { Input } from "slintcn/components/input.slint";

Input {
    placeholder: "you@example.com";
    text <=> email;
    edited(t) => { /* … */ }
}
```

--------------------------------

### Install Alert component with cargo slintcn add alert

Source: https://zero-sq.github.io/slintcn/docs/alert.html

Command to add the Alert component to your project. It installs the component and its transitive dependencies automatically.

```bash
cargo slintcn add alert
```

--------------------------------

### Install Slider with cargo slintcn add slider

Source: https://zero-sq.github.io/slintcn/docs/slider.html

Install the Slider component using the cargo package manager. The command is `cargo slintcn add slider`.

```bash
cargo slintcn add slider
```

--------------------------------

### Install Reticle with cargo slintcn add

Source: https://zero-sq.github.io/slintcn/docs/reticle.html

Install the Reticle component via the SlintCN CLI. Run this command in your project directory to add the component and its theme dependency automatically.

```bash
cargo slintcn add reticle
```

--------------------------------

### Usage example for DropdownMenu

Source: https://zero-sq.github.io/slintcn/docs/dropdown-menu.html

Shows how to import and use DropdownMenu and DropdownMenuItem in a Slint file. The component displays menu items when the trigger (a Button) is clicked, and the selected callback fires with the chosen row's index.

```slint
import { DropdownMenu, DropdownMenuItem } from "slintcn/components/dropdown-menu.slint";

DropdownMenu {
    items: [{ label: "Profile" }, { label: "Billing" }, { label: "Sign out" }];
    selected(i) => { /* … */ }
    Button { text: "Open menu"; }   // trigger = @children
}
```

--------------------------------

### Combobox usage example in Slint

Source: https://zero-sq.github.io/slintcn/docs/combobox.html

Example usage of the Combobox component. It imports Combobox and ComboboxItem, defines items with labels and values, binds selected-index and query, and handles the changed callback. The Button inside is the trigger via @children.

```slint
import { Combobox, ComboboxItem } from "slintcn/components/combobox.slint";

Combobox {
    items: [
        { label: "Apple",  value: "apple" },
        { label: "Banana", value: "banana" },
        { label: "Cherry", value: "cherry" },
    ];
    selected-index <=> picked;
    query <=> query;
    changed(i) => { /* … */ }
    Button { text: "Pick a fruit"; }   // trigger = @children
}
```
Tokens:
Raw