Pages

mint-ui

Basic information

README

Source on GitHub

Entities

Versions

2.1.0 2.0.0 1.6.0 1.5.0 1.4.0 1.3.0 1.2.0 1.1.0 1.0.0 0.0.13 0.0.12 0.0.11 0.0.10 0.0.9 0.0.8 0.0.7

Dependencies

mint-color 0.5.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 groupped 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(Never, Void)

Handles the change event from the select.

render

Html

Renders the layout.

updateToc

Updates the table of contents.

updateTocShown

(

dimensions

Dom.Dimensions

)

Updates the tocShown state based on the dimensions and breakpoint.