Options
All
  • Public
  • Public/Protected
  • All
Menu

The NotificationGrid component displays a table of notification types and methods, allowing the user to toggle each combination.

Attrs

  • user

Hierarchy

Index

Constructors

constructor

Properties

attrs

The attributes passed into the component.

see

https://mithril.js.org/components.html#passing-data-to-components

element

element: Element

The root DOM element for the component.

loading

loading: undefined | Record<string, boolean>

A map of which notification checkboxes are loading.

methods

methods: undefined | { icon: string; label: Children; name: string }[]

Information about the available notification methods.

state

state: undefined

Class component state that is persisted between redraws.

Updating this will not automatically trigger a redraw, unlike other frameworks.

This is different to Vnode state, which is always an instance of your class component.

This is undefined by default.

types

types: undefined | { icon: string; label: Children; name: string }[]

Information about the available notification types.

Methods

$

  • Returns a jQuery object for this component's element. If you pass in a selector string, this method will return a jQuery object, using the current element as its buffer.

    For example, calling component.$('li') will return a jQuery object containing all of the li elements inside the DOM element of this component.

    final

    Parameters

    • Optional selector: string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

notificationMethods

  • notificationMethods(): ItemList<{ icon: string; label: Children; name: string }>
  • Build an item list for the notification methods to display in the grid.

    Each notification method is an object which has the following properties:

    • name The name of the notification method.
    • icon The icon to display in the column header.
    • label The label to display in the column header.

    Returns ItemList<{ icon: string; label: Children; name: string }>

    }

notificationTypes

  • notificationTypes(): ItemList<{ icon: string; label: Children; name: string }>
  • Build an item list for the notification types to display in the grid.

    Each notification type is an object which has the following properties:

    • name The name of the notification type.
    • icon The icon to display in the notification grid row.
    • label The label to display in the notification grid row.

    Returns ItemList<{ icon: string; label: Children; name: string }>

    }

onbeforeremove

onbeforeupdate

oncreate

  • oncreate(vnode: any): void

oninit

  • oninit(vnode: any): void

onremove

onupdate

preferenceKey

  • preferenceKey(type: string, method: string): string

toggle

  • toggle(keys: string[]): void

toggleMethod

  • toggleMethod(method: string): void

toggleType

  • toggleType(type: string): void

view

  • view(): Element

Static component

  • component<SAttrs>(attrs?: SAttrs, children?: Children): Vnode<{}, {}>

Static initAttrs

  • initAttrs<T>(attrs: T): void

Generated using TypeDoc version 0.22.10