Skip to main content

Module feature

Module feature 

Source
Expand description

Names of IR features a target lists in TargetDescriptor::features.

Constants§

ACCORDION_LAYOUT
Accordion: columns of which one is open at a time.
ADAPTIVE_IMAGES
Image(aspect:), Grid(row_gap:) and Slider(label_hidden:).
APPEARANCE
appearance: dark or light on a part of the interface; without it the part follows the window’s appearance.
AXIS_PADDING
padding_x and padding_y: different padding across and along.
BOUND_BLUR
blur bound to state, changing with animate.
BOUND_LENGTHS
Lengths bound to expressions, such as padding: if window.idle { 0 } else { 24 }, sizes of Column, Row and Stack, and the corner of a Video.
BOUND_SHORTCUTS
Shortcuts that follow state, such as shortcut: app.keys.open and Shortcut(key: app.keys.back): the runtime reads the text each time it changes; without it a shortcut is a literal.
BUTTON_CONTENT
Button with a child that it shows instead of its label.
CAPSULE_CONTROLS
ControlGroup and capsule-shaped system controls.
CONTROLLED_TEXT
TextInput(current:): a field showing engine state, each edit running its action, the user’s text held while being edited.
CONTROLLED_VALUES
Switch(checked:), Picker(selected:), Slider(current:) and PopoverButton(open:): controls showing engine state and reporting changes as commands.
COVER_IMAGES
Image(fit: cover) without width, height or aspect: the picture covers the room its container gives, cropped.
DELAYED_APPEAR
An entrance after a delay, including the first mounted frame.
DIALOG_WINDOWS
Window(role: dialog) shown modally over the primary window; without it a dialog is a window of its own.
EDGE_GROW
Transitions growing along one axis from a fixed edge.
FILE_PICK
pick: on Button, IconButton and MenuItem: the system’s open panel asks for a file before the action runs.
FILL_BUTTONS
Button(width: fill): a system button stretched across its container, as a phone’s main action.
FORM_LAYOUT
Section(style: plain): rows on the page itself, as a heading that scrolls with its form; Section(padding_x:, padding_y:) its rows’ insets and Form(gap:) the room between its sections.
GRID_CELLS
Grid(cell_ratio:, cell_extra:): rows as tall as the column width gives, whatever their content.
ICON_LABELS
Label(display: icon): an icon with a nonvisual accessible title.
ICON_MENUS
Menu(style: icon): a menu shown as a round icon button.
ICON_TABS
Tab(display: icon): a tab showing only its icon, its label the accessible name.
IDLE_CONTROL
Window(idle_enabled:): idle detection switched on and off by state. Without it a target keeps detecting idleness all the time.
IMAGE_CORNERS
Image(corner:): an image with rounded corners.
IMAGE_TEMPLATE
Image(rendering: template): the image’s alpha takes the text color.
LOGIN_SWITCH
Switch(login_item: true): whether the system opens the application at login, shown where it can, left out elsewhere.
MENU_BAR
MenuBar in the WindowSet: the application’s menus in the system menu bar. A target whose platform has no menu bar for applications lists it as well: there the menus show nowhere, window.menu_bar is false, and nothing is left to warn about.
MODAL_COVER
Modal(cover: compact): the modal covers the whole window where it is compact.
MODAL_FLOW_TIMER
Modal, Flow, Timer, PickerOption and Stack(enabled:).
PAGE_BADGES
SidebarItem(badge:): a live count beside a page.
PAGE_SEARCH
A Search standing in the page, not in a Toolbar or Sidebar: the platform’s search field with its results below it.
PASTE
paste: on Button, IconButton, MenuItem and CommandItem: the clipboard’s text goes into a draft before the action runs.
PICTURE_FILLS
Shape(fill_from:), the average color of a picture, and fade.
POPOVER_BUTTON
PopoverButton: a button that shows its children in a popover.
RAILS
Rail: elements placed at fractions of a strip’s length.
REVEAL
reveal: hover: content shown while the pointer is over its container; without it the content always shows.
ROW_BASELINE
Row(align: baseline).
RUNTIME_IMAGES
Image(source:) from a MediaSource: a file or an http(s) URL.
RUNTIME_PALETTE
RUNTIME_THEME
WindowSet(accent:, appearance:) chosen at run time; without it the windows keep the system’s accent and appearance.
SCALED_SCENE
ScaleBox, Positioned and Marquee: a fixed coordinate scene scaled to its room.
SCROLL_ANCHOR
ScrollView(anchor:): the item of position at a fraction of the view without snapping, as near as the content reaches.
SCROLL_BROWSING
ScrollView(browsing:): a flag that holds while the person scrolls by hand.
SCROLL_SNAP
ScrollView(snap:, position:): scrolling comes to rest on an item, and a session field follows and sets the item it stands at.
SEARCH_PALETTE
Search(style: palette) and its SearchItems: a toolbar search field that grows into a results panel.
SEARCH_RESULTS
Search with children: results shown below the field.
SESSION_ACTIONS
Actions that change a session draft: draft.panel.set(true).
SHORTCUTS
Keyboard shortcuts of buttons, menu items, switches and search fields; without them the controls work from the pointer only.
SHORTCUT_INPUT
ShortcutInput: a button that takes the next key pressed, with its modifiers, as a shortcut.
SIDEBAR_HEADER
SidebarHeader: content pinned above a sidebar’s list.
SIDEBAR_WIDTH
Sidebar(width:): a sidebar of a fixed width; without it the sidebar keeps the platform’s width.
SIZE_CLASSES
The medium and large layout sizes and window.compact and its siblings in expressions.
STATUS_ITEM
StatusItem in the WindowSet: the application’s item in the system’s status area, with its menu, and the application running on after its last window closes. A target whose platform has no status area for applications lists it as well: there the item shows nowhere and nothing is left to warn about.
TABLE
Table: rows of data in columns, with a selection of the rows’ keys, a row menu, a primary action and sorting by a heading.
TAB_ACCESSORY
TabAccessory: a bar kept with the tabs over every page.
TEXT_BOLD
Text(bold:): a text bold while a condition holds.
TEXT_FORMATS
Plural branches, dates and durations in translated texts, and enum labels that show their variant’s fields.
TEXT_LINES
Text(lines:) and Text(line_height:): text limited to a number of lines, or with lines of a given height.
TEXT_WEIGHTS
text { large_title: heavy } in style!: weights of text styles.
TOGGLE_BUTTON
Switch(style: button), and a Switch in a Toolbar.
TOOLBAR_LEADING
A Spacer in a Toolbar, parting leading items from trailing ones, and Text in a toolbar.
TOOLBAR_SEARCH
Search in a Toolbar.
UNTITLED_DETAIL
Detail(titled: false): a detail column that leaves its title bar without the destination’s name, for pages that show their own.
WATCH
Watch: a command runs when the element is mounted and whenever the value it follows changes.
WINDOW_LANDSCAPE
Window(landscape:): a phone turns the window to landscape while it holds, and back to portrait. A target whose windows never turn (a television, a desktop window) lists it as well: there the property does not apply, and nothing is left to warn about.
WINDOW_SHORT
window.short: the window is shorter than the compact breakpoint.