@hmiproject/helio-sdk
    Preparing search index...

    @hmiproject/helio-sdk

    Overview of the HELIO SDK Contents

    CSS

    className

    Creates dynamic CSS class name.

    cx

    Merges multiple classNames

    keyframes

    Creates a CSS keyframes animation.

    Components

    Dialog
    RenderChildRoutes
    RenderDynamicProperty

    Displays a given DisplayDynamicPropertyRef.

    RenderInstance

    Renders an instance with a given instance id.

    RenderInstances

    Renders a list of instances.

    RenderText

    Functions

    createAction

    Creates a HELIO Action.

    createDynamicProperty

    Creates a HELIO Dynamic Property.

    createElement

    Creates a HELIO element.

    createIcon

    Creates a HELIO icon.

    createLibraryExtension

    Creates a HELIO library extension.

    createPropsSchema

    Creates a migratable schema of properties to be used in elements, actions or dynamic properties.

    Hooks

    RenderMode

    The mode in which the application is currently displaying.

    ServerStateInfo
    UseServerStateOptions
    UseServerStorageSetValue

    Callback for writing a new value of TValue to the server.

    UseServerStorageValue

    The current value, or undefined while loading.

    useAction

    Prepares an Action Ref for execution.

    useDataVariable

    Prepares a dynamic property that is expected to result in a Data Variable.

    useDynamicProperty

    Prepares an DynamicPropertyRef for usage.

    useInstanceResolver_unstable

    Might be removed in future versions or change behavior

    useLocale

    Returns the currently active application locale.

    useRawExternalAttributes

    Low-level API to read external attributes passed to the application.

    useRenderMode

    Returns the current mode in which the application is rendering.

    useSelectableElement

    Makes a DOM element selectable in the IDE.

    useServerNow

    Produces the current time on the server, updated every second.

    useServerState

    Stores a JSON value on the server and returns a tuple of the current value and a setter function.

    useText
    useTime

    Allows access to time information.

    useToast
    useZoom

    Provides the current zoom level of the application.

    Namespaces

    Namespace

    Namespace in reverse domain name notation.

    createNamespace

    Creates a namespace for library extension.

    qualifiedName

    Returns a qualified name within the given namespace.

    Other

    ActionRef
    BasicTraitRef
    ButtonProps
    ButtonVariant
    ClassPropsOf
    CreateActionOptions
    CreateActionResult
    CreateActionUseActionResult
    CreateDynamicPropertyOptions
    CreateDynamicPropertyResult
    CreateElementResult
    CreateIconOptions
    CreateIconResult
    CreateLibraryExtensionOptions
    CreateTextsResult
    DataVariableDisplayRange
    DialogProps
    DisplayActionRef
    DisplayDynamicPropertyRef

    Internal type that might change without warning and should be treated as opaque.

    DisplayInstance
    DynamicPropertyRef

    Internal type that might change without warning and should be treated as opaque.

    IconComponentProps
    Icons
    Icons
    IconSize
    InstanceRefListSchema

    Internal type that might change without warning and should be treated as opaque.

    InstanceRefSchema

    Description of a reference to a Class instantiation

    LibraryExtension
    MetaReturnType
    MetaType
    OpaqueFileRef

    File Reference.

    OpaqueFileRef

    File Reference.

    PropertyValueType
    PropsCategory
    PropsSchema
    PropsSchemaBuilder
    RenderChildRoutesProps
    RenderDynamicPropertyChildrenFunction
    RenderDynamicPropertyProps
    RenderInstanceProps
    RenderInstancesProps
    RenderTextProps
    ResolvedDynamicPropertyOptions
    RichTraitRef
    SchemaDef
    StorageScopeKind
    TextsDef
    TraitRef
    UseActionHookResult
    UseDataVariableHookResult
    UseDataVariableOptions
    UseDynamicPropertyOptions
    UseDynamicPropertyResult
    UseHookDynamicPropertyResult
    UseRawExternalAttributesResult
    UseSelectableElementResult
    UseServerNowResult
    UseServerStateResult
    UseTimeResult
    UseToastResult
    UseZoomResult
    ValueReturnType
    ValueType
    actions
    dynamicProperties
    meta
    props

    Helpers for declaring props in a PropsSchema

    values
    WidgetTrait
    Action
    Boolean

    Declares a prop that can hold a boolean value.

    Children

    Declares a prop that can hold references to other HELIO instances.

    createTexts
    DynamicProperty

    Declares a prop that can hold an DynamicProperty value.

    Enum
    fileUrl

    Returns the URL from an OpaqueFileRef.

    isActionRef
    isDynamicPropertyRef
    isInstanceRef
    isInstanceRefList
    Number

    Declares a prop that can hold a numeric value.

    String

    Declares a prop that can hold a string value.

    useTokens_unstable

    API and behavior might change at any point.

    Traits

    BufferedChangesTrait

    Makes an element have the option for buffering changes locally.

    ControlTrait

    Makes an element appear and behave as a HELIO Control.

    PageTrait

    Makes an element appear and behave as a HELIO Page.

    traits
    createBasicTrait

    Creates a new trait in the given namespace.

    UI

    IconProps
    IconRef

    Reference to a built-in HELIO icon.

    NumberInputProps
    TextInputProps
    Button

    Component that displays a clickable button using the currently active HELIO theme.

    Icon

    Displays an icon from the HELIO library.

    NumberInput

    Component that displays a numeric input field using the currently active HELIO theme.

    TextInput

    Component that displays a text input field using the currently active HELIO theme.