Class NotificationGrid

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

Attrs
  • user

Hierarchy

Constructors

constructor

Properties

attrs element loading methods state types

Methods

$ notificationMethods notificationTypes onbeforeremove onbeforeupdate oncreate oninit onremove onupdate preferenceKey toggle toggleMethod toggleType view component initAttrs

Constructors

constructor

Properties

attrs

attrs: ComponentAttrs

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

$

  • $(selector?: string): JQuery<HTMLElement>

  • 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.

    Returns

    the jQuery object for the DOM node

    Final

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

notificationMethods

  • 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

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

notificationTypes

  • 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

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

onbeforeremove

onbeforeupdate

oncreate

oninit

onremove

onupdate

preferenceKey

  • Get the name of the preference key for the given notification type-method combination.

    Returns

    Parameters

    • type: string
    • method: string

    Returns string

toggle

toggleMethod

toggleType

view

Static component

Static initAttrs

  • Initialize the component's attrs.

    This can be used to assign default values for missing, optional attrs.

    Parameters

    • attrs: unknown

    Returns void

Settings

Member Visibility

Theme

Generated using TypeDoc v0.23.24