'all' | 'attribute' | 'id'

string

string

string

string

string

string

init - KeyboardInit

Keyboard | undefined

 data-omni-keyboard-attach

boolean | string

 data-omni-keyboard-hidden

boolean

 data-omni-keyboard-mode

InputMode

 enterkeyhint

EnterKeyHint

 data-omni-keyboard-multi-line

boolean

 data-omni-keyboard-mask

boolean

 data-omni-keyboard-no-display

boolean

'text' | 'decimal' | 'numeric' | 'tel' | 'search' | 'email' | 'url'

| 'insertText'
    | 'insertReplacementText'
    | 'insertLineBreak'
    | 'insertParagraph'
    | 'insertOrderedList'
    | 'insertUnorderedList'
    | 'insertHorizontalRule'
    | 'insertFromYank'
    | 'insertFromDrop'
    | 'insertFromPaste'
    | 'insertFromPasteAsQuotation'
    | 'insertTranspose'
    | 'insertCompositionText'
    | 'insertLink'
    | 'deleteWordBackward'
    | 'deleteWordForward'
    | 'deleteSoftLineBackward'
    | 'deleteSoftLineForward'
    | 'deleteEntireSoftLine'
    | 'deleteHardLineBackward'
    | 'deleteHardLineForward'
    | 'deleteByDrag'
    | 'deleteByCut'
    | 'deleteContent'
    | 'deleteContentBackward'
    | 'deleteContentForward'
    | 'historyUndo'
    | 'historyRedo'
    | 'formatBold'
    | 'formatItalic'
    | 'formatUnderline'
    | 'formatStrikeThrough'
    | 'formatSuperscript'
    | 'formatSubscript'
    | 'formatJustifyFull'
    | 'formatJustifyCenter'
    | 'formatJustifyRight'
    | 'formatJustifyLeft'
    | 'formatIndent'
    | 'formatOutdent'
    | 'formatRemove'
    | 'formatSetBlockTextDirection'
    | 'formatSetInlineTextDirection'
    | 'formatBackColor'
    | 'formatFontColor'
    | 'formatFontName'

'enter' | 'done' | 'go' | 'next' | 'previous' | 'search' | 'send' | undefined

'numeric' | 'alpha-numeric' | 'none'

| InputEventInit
    | {
          inputType: InputEventTypes;
      }

{
    /**
     * The id to apply to the Keyboard elements.
     */
    id?: string;

    /**
     * The container to append the Keyboard as child. If not provided will append to a new div element on the document body.
     */
    parent?: string | HTMLElement | DocumentFragment | null;

    /**
     * The rule for the Keyboard to attach to inputs for showing on component focus.
     * * `all` - The Keyboard will show on focus for all input related components unless opted out with `data-omni-keyboard-hidden` on the component.
     * * `attribute` - The Keyboard will only show on focus for input related components with the `data-omni-keyboard-attach` attribute.
     * * `id` - The Keyboard will only show on focus for input related components with the `data-omni-keyboard-attach` attribute set equal to the Keyboard's id
     */
    attachMode?: 'all' | 'attribute' | 'id';

    /**
     * The text label to display by the close button.
     */
    closeLabel?: string;

    /**
     * The text label to display on the spacebar button.
     */
    spaceLabel?: string;

    /**
     * The text label to display on the clear button. The `clear` slot takes precedence over this label.
     */
    clearLabel?: string;

    /**
     * The text label to display on the call to action button when `enterkeyhint` is not defined or `enterkeyhint="enter"`. The `action-enter` slot takes precedence over this label.
     */
    actionLabel?: string;

    /**
     * A function that returns content to render within the 'clear' slot
     */
    clear?: RenderFunction;

    /**
     * A function that returns content to render within the 'caps-off' slot
     */
    capsOff?: RenderFunction;

    /**
     * A function that returns content to render within the 'caps-on' slot
     */
    capsOn?: RenderFunction;

    /**
     * A function that returns content to render within the 'caps-lock' slot
     */
    capsLock?: RenderFunction;

    /**
     * A function that returns content to render within the 'backspace' slot
     */
    backspace?: RenderFunction;

    /**
     * A function that returns content to render within the 'close' slot
     */
    close?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-enter' slot
     */
    actionEnter?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-done' slot
     */
    actionDone?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-go' slot
     */
    actionGo?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-next' slot
     */
    actionNext?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-previous' slot
     */
    actionPrevious?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-search' slot
     */
    actionSearch?: RenderFunction;

    /**
     * A function that returns content to render within the 'action-send' slot
     */
    actionSend?: RenderFunction;
}

loading_indicator

caps-off

caps-on

caps-lock

close

backspace

clear

action-done

action-go

action-next

action-previous

action-search

action-send

action-enter