@termun/core - v0.0.0
    Preparing search index...

    Class MenuChoiceConfigs

    Index

    Constructors

    constructor

    Methods

    isSelectable setSelectable getDefaultValues setDefaultValues getPageSize setPageSize getCallback setCallback toJson

    Properties

    selectable defaultValues pageSize? callback?

    Constructors

    Methods

    • Returns true when the choice menu allows multi-selection.

      Returns boolean

    • Sets whether the choice menu allows multi-selection.

      Parameters

      • v: boolean

        True to enable multi-selection.

      Returns this

    • Returns the list of pre-selected option names.

      Returns string[]

    • Replaces the pre-selected option names.

      Parameters

      • v: string[]

        Array of option names to pre-select.

      Returns this

    • Returns the page size for scrollable choice lists, or undefined for no limit.

      Returns number | undefined

    • Sets the maximum number of visible rows before scrolling kicks in.

      Parameters

      • v: number | undefined

        Number of rows, or undefined to disable paging.

      Returns this

    • Returns the submission callback, or undefined if not set.

      Returns
          | (
              (
                  data: {
                      menu: MenuChoice;
                      values: string[];
                      language?: string;
                      parent?: string;
                  },
              ) => Promise<void>
          )
          | undefined

    • Sets the callback invoked when the user confirms a selection.

      Parameters

      • v:
            | (
                (
                    data: {
                        menu: MenuChoice;
                        values: string[];
                        language?: string;
                        parent?: string;
                    },
                ) => Promise<void>
            )
            | undefined

        Async callback receiving the menu and selected values.

      Returns this

    Properties

    selectable: NonNullable<boolean | undefined> = false
    defaultValues: string[] = []
    pageSize?: number
    callback?: (
        data: {
            menu: MenuChoice;
            values: string[];
            language?: string;
            parent?: string;
        },
    ) => Promise<void>

    Settings

    Member Visibility

    On This Page

    Constructors
    Methods
    Properties