Try Install Learn Blog API Packages GitHub
Pages
mint-ui

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

Ui.Layout.Documentation

A layout component for displaying documentation.

States

tocItems
:
Array(Tuple(String, String))
=
[]

The items for the table of contents.

tocShown
:
Bool
=
false

A variable to store when to show the table of contents.

Properties

children
:
Array(Html)
=
[]

The content to render.

items
:
Array(Ui.NavItem)
=
[]

The items grouped by a string.

mobileNavigationLabel
:
Html
=
<{ "Pages" }>

The content to display in the mobile navigation select.

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

The size of the component.

tocBreakpoint
:
Number
=
1440

The breakpoint to render the table of contents.

Functions

getTocData
(
element
:
Dom.Element
)
:
Tuple(String, String)

Gets the table of contents data of an element.

openActionSheet
(
event
:
Html.Event
)
:
Promise(Void)

Handles the change event from the select.

render
:
Html

Renders the layout.

Updates the table of contents.

updateTocShown
(
dimensions
:
Dom.Dimensions
)

Updates the tocShown state based on the dimensions and breakpoint.