Options
All
  • Public
  • Public/Protected
  • All
Menu

Module core/components

Index

Types

Entries

Textbox

Slider

Listbox

Radio

Checkbox

UpdateButton

SettleButton

Field

Dialog

Feedback

Modal

Progress

Page

Switch

ListItem

Pagination

Flatpickr

Pickr

Sortable

Other

Types

OnCreateFunc

OnCreateFunc: (el: Element) => void

Type declaration

    • (el: Element): void

    • oncreate lifecycle hook.

      Parameters

      • el: Element

      Returns void

UnmagicalComponent

UnmagicalComponent<Attributes>: Component<Attributes, any, any>

Type parameters

  • Attributes

NodeName

NodeName<A>: UnmagicalComponent<A> | string

Type parameters

  • A

Hoc

Hoc<A>: (c: NodeName<A>) => UnmagicalComponent<A>

Type parameters

  • A

Type declaration

VNode

Re-exports VNode

Entries

Const suspendRoot

  • suspendRoot(): void

Const resumeRoot

  • resumeRoot(): void

Const prepareToDestroy

  • prepareToDestroy(el: Element, anim: Animation, done: () => void): void

Const compose

  • compose<Attrs>(p1: Hoc<Attrs>, p2: Hoc<Attrs>): Hoc<Attrs>

Textbox

TextboxExtraProps

TextboxExtraProps: { path: string }

Properties users provide to Textbox component.

Type declaration

  • path: string

    Json path to the value, which bound to a Textbox.

TextboxAutoProps

TextboxAutoProps: { data-mg-path: string; data-mg-value-attribute: string; oninput: UnmagicalAction<Event>; onblur: UnmagicalAction<Event>; value: string; invalid: boolean; message: string }

Properties an implementor of Textbox get.

Type declaration

  • data-mg-path: string

    Unmagical will use this property. Please render as is.

  • data-mg-value-attribute: string

    Unmagical will use this property. Please render as is.

  • oninput: UnmagicalAction<Event>

    Unmagical will use this property. Please render as is.

  • onblur: UnmagicalAction<Event>

    Unmagical will use this property. Please render as is.

  • value: string

    Unmagical will use this property. Please render as is.

  • invalid: boolean

    True if the validation of an input string failed.

  • message: string

    An error message of the validation. An empty string if the validation succeeded.

Const playTextbox

Slider

SliderExtraProps

SliderExtraProps: { path: string }

Type declaration

  • path: string

SliderAutoProps

SliderAutoProps: { data-mg-path: string; data-mg-value-attribute: string; oninput: UnmagicalAction<Event>; onchange: UnmagicalAction<Event>; value: string; invalid: boolean; message: string }

Type declaration

  • data-mg-path: string
  • data-mg-value-attribute: string
  • oninput: UnmagicalAction<Event>
  • onchange: UnmagicalAction<Event>
  • value: string
  • invalid: boolean
  • message: string

Const playSlider

Listbox

ListboxExtraProps

ListboxExtraProps: { path: string }

Type declaration

  • path: string

ListboxAutoProps

ListboxAutoProps: { data-mg-path: string; data-mg-value-attribute: string; onchange: UnmagicalAction<Event>; invalid: boolean; message: string; value: string }

Type declaration

  • data-mg-path: string
  • data-mg-value-attribute: string
  • onchange: UnmagicalAction<Event>
  • invalid: boolean
  • message: string
  • value: string

Const playListbox

Radio

RadioExtraProps

RadioExtraProps: { path: string; value: string }

Type declaration

  • path: string
  • value: string

RadioAutoProps

RadioAutoProps: { data-mg-path: string; data-mg-value-attribute: string; onchange: UnmagicalAction<Event>; checked: boolean; invalid: boolean; message: string; value: string }

Type declaration

  • data-mg-path: string
  • data-mg-value-attribute: string
  • onchange: UnmagicalAction<Event>
  • checked: boolean
  • invalid: boolean
  • message: string
  • value: string

Const playRadio

Checkbox

CheckboxExtraProps

CheckboxExtraProps: { path: string }

Type declaration

  • path: string

CheckboxAutoProps

CheckboxAutoProps: { data-mg-path: string; data-mg-checked-attribute: string; onchange: UnmagicalAction<Event>; checked: boolean; invalid: boolean; message: string }

Type declaration

  • data-mg-path: string
  • data-mg-checked-attribute: string
  • onchange: UnmagicalAction<Event>
  • checked: boolean
  • invalid: boolean
  • message: string

Const playCheckbox

UpdateButton

UpdateButtonExtraProps

UpdateButtonExtraProps: { update: string; params: Json }

Type declaration

  • update: string
  • params: Json

UpdateButtonAutoProps

UpdateButtonAutoProps: { data-mg-update: string; data-mg-params: string; onclick: UnmagicalAction<Event> }

Type declaration

  • data-mg-update: string
  • data-mg-params: string
  • onclick: UnmagicalAction<Event>

Const playUpdateButton

SettleButton

SettleButtonExtraProps

SettleButtonExtraProps: { name: string; result: Json }

Type declaration

  • name: string
  • result: Json

SettleButtonAutoProps

SettleButtonAutoProps: { data-mg-name: string; data-mg-result: string; onclick: UnmagicalAction<Event> }

Type declaration

  • data-mg-name: string
  • data-mg-result: string
  • onclick: UnmagicalAction<Event>

Const playSettleButton

Field

FieldExtraProps

FieldExtraProps: { path: string; foldValidity?: boolean }

Type declaration

  • path: string
  • Optional foldValidity?: boolean

FieldAutoProps

FieldAutoProps: { invalid: boolean; message: string }

Type declaration

  • invalid: boolean
  • message: string

Const playField

Dialog

DialogExtraProps

DialogExtraProps: { name: string }

Type declaration

  • name: string

DialogAutoProps

DialogAutoProps: { name: string; data: any; oncreate: OnCreateFunc; onremove: OnRemoveFunc; shown: boolean }

Type declaration

Const playDialog

Feedback

FeedbackExtraProps

FeedbackExtraProps: { name: string; duration?: number }

Type declaration

  • name: string
  • Optional duration?: number

FeedbackAutoProps

FeedbackAutoProps: { name: string; data: any; shown: boolean; oncreate: OnCreateFunc; onremove: OnRemoveFunc }

Type declaration

Const playFeedback

Modal

ModalExtraProps

ModalExtraProps: { shown: boolean }

Type declaration

  • shown: boolean

ModalAutoProps

ModalAutoProps: { shown: boolean; oncreate: OnCreateFunc; onremove: OnRemoveFunc }

Type declaration

Const playModal

Progress

ProgressExtraProps

ProgressExtraProps: { name: string }

Type declaration

  • name: string

ProgressAutoProps

ProgressAutoProps: { name: string; shown: boolean; current: number | undefined }

Type declaration

  • name: string
  • shown: boolean
  • current: number | undefined

Const playProgress

Page

PageExtraProps

PageExtraProps: { index: number; name: string }

Type declaration

  • index: number
  • name: string

PageAutoProps

PageAutoProps: { index: number; name: string; shown: boolean }

Type declaration

  • index: number
  • name: string
  • shown: boolean

Const playPage

Switch

SwitchExtraProps

SwitchExtraProps: { name: string }

Type declaration

  • name: string

SwitchAutoProps

SwitchAutoProps: { name: string; shown: boolean }

Type declaration

  • name: string
  • shown: boolean

Const playSwitch

ListItem

ListItemExtraProps

ListItemExtraProps: {}

Type declaration

    ListItemAutoProps

    ListItemAutoProps: { oncreate: OnCreateFunc; onremove: OnRemoveFunc }

    Type declaration

    Const playListItem

    Pagination

    PaginationExtraProps

    PaginationExtraProps: { listPath: string; width?: number; pageProperty?: string; limitProperty?: string }

    Type declaration

    • listPath: string
    • Optional width?: number
    • Optional pageProperty?: string
    • Optional limitProperty?: string

    PaginationAutoProps

    PaginationAutoProps: { listPath: string; current: number | null; prev: number | null; next: number | null; first: number | null; last: number | null; siblings: number[] }

    Type declaration

    • listPath: string
    • current: number | null
    • prev: number | null
    • next: number | null
    • first: number | null
    • last: number | null
    • siblings: number[]

    Const playPagination

    Flatpickr

    FlatpickrExtraProps

    FlatpickrExtraProps: { path: string; clearerId: string | null; config: object }

    Type declaration

    • path: string
    • clearerId: string | null
    • config: object

    FlatpickrAutoProps

    FlatpickrAutoProps: { invalid: boolean; message: string; oncreate: OnCreateFunc; ondestroy: OnDestroyFunc }

    Type declaration

    Const playFlatpickr

    Pickr

    PickrExtraProps

    PickrExtraProps: { path: string; clearerId: string; options: object }

    Type declaration

    • path: string
    • clearerId: string
    • options: object

    PickrAutoProps

    PickrAutoProps: { value: string; invalid: boolean; message: string; oncreate: OnCreateFunc; ondestroy: OnDestroyFunc }

    Type declaration

    Const playPickr

    Sortable

    SortableExtraProps

    SortableExtraProps: { name: string; path: string; options: object }

    Type declaration

    • name: string
    • path: string
    • options: object

    SortableAutoProps

    SortableAutoProps: { data-mg-path: string; active: boolean; itemPath: string; group: string; oncreate: OnCreateFunc; ondestroy: OnDestroyFunc }

    Type declaration

    Const playSortable

    Other

    API

    Re-exports API

    h

    Re-exports h

    OnRemoveFunc

    OnRemoveFunc: (el: Element, done: () => void) => void

    Type declaration

      • (el: Element, done: () => void): void

      • onremove lifecycle hook.

        Parameters

        • el: Element
        • done: () => void
            • (): void

            • Returns void

        Returns void

    OnDestroyFunc

    OnDestroyFunc: (el: Element) => void

    Type declaration

      • (el: Element): void

      • ondestroy lifecycle hook.

        Parameters

        • el: Element

        Returns void

    Generated using TypeDoc