Flarum (v2.0.0-beta.4)
    Preparing search index...

    Class NotificationGrid

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

    • user

    Hierarchy (View Summary)

    Index

    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

    Properties

    attrs: ComponentAttrs

    The attributes passed into the component.

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

    element: Element

    The root DOM element for the component.

    loading: Record<string, boolean> | undefined

    A map of which notification checkboxes are loading.

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

    Information about the available notification methods.

    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: { icon: string; label: Children; name: string }[] | undefined

    Information about the available notification types.

    Methods

    $

    • $(selector?: string): JQuery

      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.

      Parameters

      • Optionalselector: string

        a jQuery-compatible selector string

      Returns JQuery

      the jQuery object for the DOM node

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

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

    Settings

    Member Visibility

    On This Page

    Attrs
    Constructors
    Properties
    Methods