Class EditGroupModal<CustomAttrs>

The EditGroupModal component shows a modal dialog which allows the user to create or edit a group.

Type Parameters

Hierarchy

  • Modal<CustomAttrs>
    • EditGroupModal

Constructors

Properties

alertAttrs: null | AlertAttrs = null

Attributes for an alert component to show below the header.

attrs: CustomAttrs

The attributes passed into the component.

color: Stream<string>
element: Element

The root DOM element for the component.

group: Group
icon: Stream<string>
isHidden: Stream<boolean>
loading: boolean = false
namePlural: Stream<string>
nameSingular: Stream<string>
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.

isDismissible: boolean = true

Determine whether or not the modal should be dismissible via an 'x' button.

Deprecated

Use the individual isDismissibleVia... attributes instead and remove references to this.

isDismissibleViaBackdropClick: boolean = true

Can the modal be dismissed via a click on the backdrop.

isDismissibleViaCloseButton: boolean = true

Can the model be dismissed with a close button (X)?

If false, no close button is shown.

isDismissibleViaEscKey: boolean = true

Can the modal be dismissed by pressing the Esc key on a keyboard?

Accessors

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.

    Parameters

    • Optional selector: string

      a jQuery-compatible selector string

    Returns JQuery<HTMLElement>

    the jQuery object for the DOM node

    Final

  • Returns {
        color: string;
        icon: string;
        isHidden: boolean;
        namePlural: string;
        nameSingular: string;
    }

    • color: string
    • icon: string
    • isHidden: boolean
    • namePlural: string
    • nameSingular: string

Generated using TypeDoc v0.24.8