StippleUI.Lists.list - Function
list(args...; kwargs...)
The list
and item
are a group of components which can work together to present multiple line items vertically as a single continuous element. They are best suited for displaying similar data types as rows of information, such as a contact list, a playlist or menu. Each row is called an Item. item
can also be used outside of a list
too.
Examples
View
julia> list(bordered=true, separator=true, [
item(clickable=true, vripple=true, [
itemsection("Single line item")
]),
item(clickable=true, vripple=true, [
itemsection([
itemlabel("Item with caption"),
itemlabel("Caption", caption=true)
])
]),
item(clickable=true, vripple=true, [
itemsection([
itemlabel("OVERLINE", overline=true),
itemlabel("Item with caption")
])
])
])
Arguments
- Content
separator::Bool
- Applies a separator between contained itemspadding:Bool
- Applies a material design-like padding on top and bottom
- Style
bordered::Bool
- Applies a default border to the componentdense::Bool
- Dense mode; occupies less spacedark::Bool
- Notify the component that the background is a dark color
StippleUI.Lists.item - Function
item(args...; kwargs...)
Arguments
- Content
tag::String
- HTML tag to render; Suggestion: use 'label' when encapsulating acheckbox
/radio
/toggle
so that when user clicks/taps on the whole item it will trigger a model change for the mentioned components ex.a
label
div
insetlevel::Int
- Apply an inset; Useful when avatar/left side is missing but you want to align content with other items that do have a left side, or when you're building a menu ex.insetlevel!="1"
- General
tabindex::Union{Int, String}
- Tabindex HTML attribute value ex.0
100
- Navigation
href::String
- Native <a> link href attribute; Has priority over the 'to'/'exact'/'replace' props ex.http://genieframework.com
target::String
- Native <a> link target attribute; Use it only along with 'href' prop; Has priority over the 'to'/'exact'/'replace' props_blank
_self
_parent
_top
- State
disable::Bool
- Put component in disabled modeactive::Bool
- Put item into 'active' stateclickable::Bool
- Isitem
clickable? If it's the case, then it will add hover effects and emit 'click' eventsmanualfocus::Bool
- Put item into a manual focus state; Enables 'focused' prop which will determine if item is focused or not, rather than relying on native hover/focus statesfocused::Bool
- Determines focus state, ONLY if 'manual-focus' is enabled / set to true
- Style
dark::Bool
- Notify the component that the background is a dark colordense::Bool
- Dense mode; occupies less space
StippleUI.Lists.item_section - Function
item_section(args...; kwargs...)
Arguments
avatar::Bool
- Render an avatar item side (does not needs 'side' prop to be set)thumbnail::Bool
- Render a thumbnail item side (does not needs 'side' prop to be set)side::Bool
- Renders as a side of the itemtop::Bool
- Align content to top (useful for multi-line items)nowrap::Bool
- Do not wrap text (useful for item's main content)
StippleUI.Lists.itemsection - Function
item_section(args...; kwargs...)
Arguments
avatar::Bool
- Render an avatar item side (does not needs 'side' prop to be set)thumbnail::Bool
- Render a thumbnail item side (does not needs 'side' prop to be set)side::Bool
- Renders as a side of the itemtop::Bool
- Align content to top (useful for multi-line items)nowrap::Bool
- Do not wrap text (useful for item's main content)
StippleUI.Lists.item_label - Function
item_label(args...; kwargs...)
Arguments
- Behaviour
lines::Union{Int, String}
- Apply ellipsis when there's not enough space to render on the specified number of lines; ex.1
3
lines!="2"
- Content
overline::Bool
- Renders an overline labelcaption::Bool
- Renders a caption labelheader::Bool
- Renders a header labellines::Union{Int, String}
- Apply ellipsis when there's not enough space to render on the specified number of lines;1
3
lines!="2"
StippleUI.Lists.itemlabel - Function
item_label(args...; kwargs...)
Arguments
- Behaviour
lines::Union{Int, String}
- Apply ellipsis when there's not enough space to render on the specified number of lines; ex.1
3
lines!="2"
- Content
overline::Bool
- Renders an overline labelcaption::Bool
- Renders a caption labelheader::Bool
- Renders a header labellines::Union{Int, String}
- Apply ellipsis when there's not enough space to render on the specified number of lines;1
3
lines!="2"