Creates dynamic CSS class name.
Merges multiple classNames
Creates a CSS keyframes animation.
Changes the container nesting depth for rendered child elements.
Displays a given DisplayDynamicPropertyRef.
Renders an instance with a given instance id.
Renders a list of instances.
Creates a HELIO Action.
Creates a HELIO Dynamic Property.
Creates a HELIO element.
Creates a HELIO icon.
Creates a HELIO library extension.
Creates a migratable schema of properties to be used in elements, actions or dynamic properties.
The resolved visual appearance of the surface the element's content currently sits on — the visible surrounding container.
The layer the surrounding container is rendered in.
The mode in which the application is currently displaying.
Callback for writing a new value of TValue to the server.
The current value, or undefined while loading.
Prepares an Action Ref for execution.
Describes the surrounding container the element's content sits on — the visible container — so the content can blend in with, or deliberately react to, its surroundings.
Prepares a dynamic property that is expected to result in a Data Variable.
Returns all Design Tokens as a single object.
Prepares an DynamicPropertyRef for usage.
Might be removed in future versions or change behavior
Returns the currently active application locale.
Low-level API to read external attributes passed to the application.
Returns the current mode in which the application is rendering.
Makes a DOM element selectable in the IDE.
Produces the current time on the server, updated every second.
Stores a JSON value on the server and returns a tuple of the current value and a setter function.
Allows access to time information.
Provides the current zoom level of the application.
Namespace in reverse domain name notation.
Creates a namespace for library extension.
Returns a qualified name within the given namespace.
Mapping of all available token names to their type
Internal type that might change without warning and should be treated as opaque.
Internal type that might change without warning and should be treated as opaque.
Hint for which control the editor uses to display enum options.
Internal type that might change without warning and should be treated as opaque.
Description of a reference to a Class instantiation
File Reference.
File Reference.
Condition on a sibling prop of the same schema level, used by visibleIf
and enabledIf. The condition matches while the sibling prop's value equals
equals (or is contained in oneOf); notEquals and notOneOf are the
negated counterparts.
The typography subset a size token surfaces: the concrete values a typography
size (e.g. typographySize05) resolves to. All values are length strings
(pixel strings as defaults, CSS variable references inside HELIO).
Helpers for declaring visibleIf/enabledIf conditions on props in a
PropsSchema.
Helpers for declaring props in a PropsSchema
Declares a prop that can hold a boolean value.
Declares a prop that can hold references to other HELIO instances.
Declares a prop that can hold an DynamicProperty value.
Declares a prop that can hold a value from a set of options.
Returns the URL from an OpaqueFileRef.
Declares a prop that holds an ordered list of values of a single item type.
Declares a prop that can hold a numeric value.
Declares a prop that groups a set of nested props into a single object value.
Declares a prop that can hold a string value.
API and behavior might change at any point.
Makes an element have the option for buffering changes locally.
Makes an element appear and behave as a HELIO Control.
Makes an element appear and behave as a HELIO Page.
Makes an element appear and behave as a HELIO Widget.
Creates a new trait in the given namespace.
A single button of a ButtonGroup.
The selection behavior of a ButtonGroup: either a single value can be active at a time, or multiple values can be active simultaneously.
The checked state of a Checkbox. In addition to the boolean true
and false states, a checkbox can be 'indeterminate'.
A single selectable option of a Dropdown.
Reference to a built-in HELIO icon.
A single selectable option of a RadioGroup.
Component that displays a clickable button using the currently active HELIO theme.
Component that displays a group of toggleable buttons, using the currently
active HELIO theme. Supports activating a single value or multiple values at
once via the type prop.
Component that displays a checkbox using the currently active HELIO theme.
Component that displays a dropdown to select one of the given options, using the currently active HELIO theme.
Displays an icon from the HELIO library.
Component that displays a numeric input field using the currently active HELIO theme.
Component that displays a group of radio buttons to select one of the given options, using the currently active HELIO theme.
Component that displays a switch using the currently active HELIO theme.
Component that displays a text input field using the currently active HELIO theme.
Overview of the HELIO SDK Contents
Functions
Creating an Extension