Try Install Learn Blog API Packages GitHub
Pages
mint-ui

Search
Basic information
Entities
Versions
Dependencies
mint-color 0.0.0 <= v < 1.0.0

Ui.Example

A component to display and example, controls and source code of a component.

States

width
:
Number
=
0

A state to hold the width of the component.

Properties

breakpoint
:
Number
=
1000

Controls when to use a one column layout.

controls
:
Html
=
<></>

The controls to display on the right.

data
:
Tuple(Html, String)

The example and it's source code to display.

fullWidth
:
Bool
=
false

Whether or not the example expands to full width.

highlight
:
Function(String, Html)
=
(code : String) { <{ code }> }

Highlights the given code (converts it to Html).

Controls the horizontal spacing between the elements.

size
:
Ui.Size
=
Ui.Size::Inherit

The size of the component.

verticalSpacing
:
Number
=
0

Controls the vertical spacing between the elements.

warning
:
Html
=
<></>

The content for the warning area.

Functions

render
:
Html

Renders the component.

updateWidth
(
dimensions
:
Dom.Dimensions
)

Updates the mobile state based on the dimensions and breakpoint.