Guide¶
Basics¶
Take your first steps with Nitro.
- Hello World!
- Formatting content
- Show multiline content
- Show multiple items
- Show multiple items, one at a time
- Style text
- Get user input
- Get multiple inputs, one at a time
- Get multiple inputs at once
- Putting it all together
Markdown¶
Use Markdown to display rich text, tables, and code.
- Basics
- Handle clicks on links
- Show tables
- Create tables from lists
- Syntax highlighting in code blocks
Styling¶
Change how boxes look: colors, borders, sizing, margins, and padding.
Images¶
Display images, or use them as backgrounds or in patterns.
Layout¶
Compose and arrange boxes to lay out content and control flow.
- Basic
- Rows
- Fit
- Columns
- Combine rows and columns
- Grids
- Groups
- Tabs
- Vertical Tabs
- Tabs with icons
- Vertical Tabs with icons
- Select tab
- Select vertical tab
Forms¶
Learn the basics of collecting inputs from the user.
Editing¶
Make changes to content already displayed on a page.
- Basics
- Overwrite
- Overwrite before
- Overwrite after
- Overwrite inside
- Add
- Add before
- Add at
- Add after
- Add inside
- Clear
- Clear before
- Clear after
- Clear inside
- Selecting nested boxes
Popups¶
Display content in popup dialogs.
Textbox¶
Use textboxes to capture text inputs and passwords.
- Basic
- Set initial value
- Set a label
- Show placeholder text
- Mark as required
- Control input format
- Show an icon
- Set prefix text
- Set suffix text
- Set both prefix and suffix texts
- Show an error message
- Accept a password
- Enable multiple lines
- Disable
Spinbox¶
Use spinboxes to capture numeric inputs. A spinbox lets users incrementally adjust a value in small steps.
- Basic
- Set initial value
- Set min value
- Set max value
- Set step
- Set precision
- Combine min, max, step, precision
- Set range
- Set range with step
- Set range with precision
- Use zero-crossing ranges
- Use fractional steps
- Handle changes immediately
- Disable
Checkbox¶
Use a checkbox to choose between two mutually exclusive options.
Toggle¶
Use a toggle to choose between two mutually exclusive options, with an immediate result.
Pickers¶
Use pickers to pick one or more options from several options. Buttons, checklists, dropdowns, and color pickers are all examples of pickers.
- Basic
- Show buttons
- Show radio buttons
- Show a dropdown menu
- Show a dropdown list
- Show a checklist
- Shorthand
- Mark as required
- Show an error message
Options¶
Learn how to create options for pickers. Options can be created from strings, sequences, tuples, or dictionaries.
- Basic
- Create options from a sequence
- Create options from a string
- Create options from tuples
- Create options from a dictionary
- Mark options as selected
- Set initial selection
Buttons¶
Use buttons to allow users to trigger actions. They can be thought of as pickers that produce an immediate result when selected.
- Basic
- Shorthand notation
- Mark button as primary
- Select primary button
- Select multiple primary buttons
- Add a menu
- Add a menu to a primary button
- Set a caption
- Lay out buttons vertically
- Disable
Radio Buttons¶
Use radio buttons to pick one option from a small number of options.
- Basic
- Set initial selection
- Mark options as selected
- Show pictorial options
- Handle changes immediately
- Disable
Dropdown¶
Use a dropdown to pick one option from a large number of options.
- Basic
- Set initial selection
- Mark options as selected
- Group options
- Enable arbitrary input
- Handle changes immediately
- Disable
Dropdown List¶
Use a dropdown list to pick one or more options from a large number of options.
Checklist¶
Use checkboxes to pick one or more options from a small number of options.
Table¶
Use tables to display detailed information in the form of a grid. Tables can be thought of as pickers that allow one or more rows to be selected. They are a good replacement for dropdowns and dropdown lists when each option has several displayable attributes.
- Basic
- Make rows clickable
- Use markdown in cells
- Enable single select
- Enable multi-select
- Set initial selection
- Mark rows as selected
- Group rows
- Group rows at multiple levels
- Set column width
- Set header icon
- Disable column resizing
- Enable multiline cells
- Handle changes immediately
Slider¶
Use sliders to allow picking a number in a given range.
- Basic
- Set initial value
- Set min value
- Set max value
- Set step
- Set precision
- Combine min, max, step, precision
- Set range
- Set range with step
- Set range with precision
- Zero-crossing range
- Set fractional steps
- Handle changes immediately
- Disable
Range Slider¶
Use range sliders to allow picking a numeric range within a given range.
- Basic
- Set min value
- Set max value
- Set step
- Set precision
- Combine min, max, step, precision
- Set range
- Set range with step
- Set range with precision
- Use zero-crossing range
- Set fractional steps
- Handle changes immediately
- Disable
Time Picker¶
Use a time picker to pick a time using a 12- or 24-hour clock.
- Basic
- Enable seconds
- Show hours only
- Show 24-hour clock
- Show 24-hour clock, with seconds
- Show 24-hour clock, with hour only
- Handle changes immediately
- Disable
Date Picker¶
Use a date picker to pick a date within a range. A date picker is a compact form of the calendar.
- Basic
- Set initial date
- Set placeholder text
- Set min date
- Set max date
- Combine min and max date
- Set range
- Mark as required
- Handle changes immediately
- Disable
Calendar¶
Use a calendar to pick a date within a range. The calendar is an expanded form of a date picker.
- Basic
- Set initial date
- Set min date
- Set max date
- Combine min and max dates
- Set range
- Handle changes immediately
- Disable
Week Picker¶
Use a week picker to pick a week in a given range.
- Basic
- Set initial week
- Set min date
- Set max date
- Combine min and max dates
- Set range
- Handle changes immediately
- Disable
Month Picker¶
Use a month picker to pick a month in a given range.
- Basic
- Set initial month
- Set min date
- Set max date
- Combine min and max dates
- Set range
- Handle changes immediately
- Disable
Tag Picker¶
Use a tag picker to pick one or more tags (short strings or labels) from a group.
Color Picker¶
Use a color picker to pick an arbitrary color.
Color Palette¶
Use a color palette to pick one color from a group of colors.
Rating¶
Use a rating component to capture a star-rating.
- Basic
- Set initial rating
- Allow zero stars
- Set maximum number of stars
- Combine min and max stars
- Set range
- Handle changes immediately
- Disable
File Upload¶
Use a file upload component to get one or more files from the user.
Inputs¶
Create custom input components that respond to gestures.
Banner¶
Use banners to show errors, warnings, or important information related to an operation.
Progress Bar¶
Use progress bars to show the completion status of long-running operations.
Spinner¶
Use a spinner to indicate that a long-running operation is in progress, and it's unsure how long it will take to complete.
Graphics¶
Draw visualizations, microcharts, sparklines, and other data graphics.
- Introduction
- Point
- Line
- Curve
- Step
- Bar
- Stroke
- Tick
- Guide
- Gauge
- Circular Gauge
- Label
- Rectangle
- Arc
- Polyline
- Polygon
- Link
- Spline
- Win Loss
- Stacked bar
- Bullet graph
- Sankey diagram
- Network graph
Format¶
Learn the basics of formatting and templates.
- Basic
- Nested data
- Arrays
- Nested arrays
- Format number
- Format date
- Format lists
- Format list sizes
- Format locale
Format Numbers¶
Language-sensitive number and currency formatting.
- Basic
- Integer Digits
- Fraction digits
- Significant digits
- Percent
- Scientific
- Engineering
- Compact
- Currency
- Accounting
- Sign
- Units
- Numbering
Format Dates¶
Language-sensitive date, time, and relative time formatting.
- Basic
- Time
- Date and time
- Date style
- Time style
- Calendar
- Custom
- Day period
- Era
- Time zone
- Numbering
- Relative Time
Help¶
Show context-sensitive hints and help.
- Basic
- Using Markdown
- Navigation
- Localization
- Hint
- Hint with title
- Hint with help
- Hint localization
- More examples
Hotkeys¶
Assign keyboard shortcuts to actions.
Separator¶
Use a separator to visually separate form inputs into sections.
Components¶
A selection of useful components that you can copy and adapt.
- Tag
- Badge
- Avatar
- CTA
- Dark CTA
- CTA with image
- Alert
- Alert with description
- Alert with icon
- Pagination
- Pagination with round buttons
- Progress indicator
- Stat
- Stat with icon
- Stat with change
- Stat with floating change
Cards¶
Create content cards by stacking boxes together.
Theming¶
Learn how to customize your app's color scheme.
- Set initial theme
- Switch themes dynamically
- Prose color sampler
- Color palette
- Accent color styles
- Accent color sampler
Advanced¶
Learn some advanced tips and tricks to level up your Nitro skills.