mithril-materialized
    Preparing search index...

    Interface RatingAttrs

    Rating component attributes

    interface RatingAttrs {
        allowHalfSteps?: boolean;
        "aria-label"?: string;
        "aria-labelledby"?: string;
        ariaLabel?: string;
        class?: string;
        className?: string;
        clearable?: boolean;
        defaultValue?: number;
        density?: RatingDensity;
        disabled?: boolean;
        getLabelText?: (value: number, max: number) => string;
        icon?: RatingIconConfig;
        id?: string;
        key?: string | number;
        max?: number;
        name?: string;
        onchange?: (value: number) => void;
        onmouseover?: (value: number) => void;
        readonly?: boolean;
        showTooltips?: boolean;
        size?: RatingSize;
        step?: number;
        style?: any;
        tooltipLabels?: string[];
        value?: number;
        onbeforeremove?(this: any, vnode: VnodeDOM<any, any>): void | Promise<any>;
        onbeforeupdate?(
            this: any,
            vnode: Vnode<any, any>,
            old: VnodeDOM<any, any>,
        ): boolean | void;
        oncreate?(this: any, vnode: VnodeDOM<any, any>): any;
        oninit?(this: any, vnode: Vnode<any, any>): any;
        onremove?(this: any, vnode: VnodeDOM<any, any>): any;
        onupdate?(this: any, vnode: VnodeDOM<any, any>): any;
        [property: string]: any;
    }

    Hierarchy

    • Attributes
      • RatingAttrs

    Indexable

    • [property: string]: any

      Any other virtual element properties, including attributes and event handlers.

    Index

    Properties

    allowHalfSteps? aria-label? aria-labelledby? ariaLabel? class? className? clearable? defaultValue? density? disabled? getLabelText? icon? id? key? max? name? onchange? onmouseover? readonly? showTooltips? size? step? style? tooltipLabels? value?

    Methods

    onbeforeremove? onbeforeupdate? oncreate? oninit? onremove? onupdate?

    Properties

    allowHalfSteps?: boolean

    Whether to allow fractional display (e.g., 3.5 stars)

    "aria-label"?: string

    ARIA label for the component

    "aria-labelledby"?: string

    ARIA labelledby reference

    ariaLabel?: string

    ARIA label for the component (camelCase alternative)

    class?: string

    The class name(s) for this virtual element, as a space-separated list.

    className?: string

    Class name for the container

    clearable?: boolean

    Whether the rating can be cleared/reset to 0

    defaultValue?: number

    Initial value for uncontrolled mode

    density?: RatingDensity

    Density variant

    disabled?: boolean

    Whether the rating is disabled

    getLabelText?: (value: number, max: number) => string

    Function to get label text for accessibility

    icon?: RatingIconConfig

    Custom icon configuration

    id?: string

    HTML ID for the component

    key?: string | number

    A key to optionally associate with this element.

    max?: number

    Maximum rating value (default: 5)

    name?: string

    Name for form submission

    onchange?: (value: number) => void

    Callback when rating changes

    onmouseover?: (value: number) => void

    Callback when rating is hovered (preview mode)

    readonly?: boolean

    Whether the rating is read-only

    showTooltips?: boolean

    Whether to show tooltips on hover

    size?: RatingSize

    Size variant

    step?: number

    Step size for rating increments (default: 1, can be 0.5 for half-steps)

    style?: any

    Additional CSS styles

    tooltipLabels?: string[]

    Custom tooltip labels for each rating value

    value?: number

    Current rating value

    Methods

    • The onbeforeremove hook is called before a DOM element is detached from the document. If a Promise is returned, Mithril only detaches the DOM element after the promise completes.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns void | Promise<any>

    • The onbeforeupdate hook is called before a vnode is diffed in a update.

      Parameters

      • this: any
      • vnode: Vnode<any, any>
      • old: VnodeDOM<any, any>

      Returns boolean | void

    • The oncreate hook is called after a DOM element is created and attached to the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    • The oninit hook is called before a vnode is touched by the virtual DOM engine.

      Parameters

      • this: any
      • vnode: Vnode<any, any>

      Returns any

    • The onremove hook is called before a DOM element is removed from the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    • The onupdate hook is called after a DOM element is updated, while attached to the document.

      Parameters

      • this: any
      • vnode: VnodeDOM<any, any>

      Returns any

    Settings

    Member Visibility

    On This Page

    Properties
    Methods