Interface IFileListFilter

interface IFileListFilter {
    addEventListener: <T extends string>(
        type: T,
        listener:
            | null
            | TypedEventListenerOrEventListenerObject<IFileListFilterEvents, T>,
        options?: boolean | AddEventListenerOptions,
    ) => void;
    dispatchEvent: (event: Event) => boolean;
    id: string;
    order: number;
    removeEventListener: <T extends string>(
        type: T,
        callback:
            | null
            | TypedEventListenerOrEventListenerObject<IFileListFilterEvents, T>,
        options?: boolean | EventListenerOptions,
    ) => void;
    dispatchTypedEvent<T extends keyof IFileListFilterEvents>(
        _type: T,
        event: IFileListFilterEvents[T],
    ): boolean;
    filter(nodes: INode[]): INode[];
    mount(el: HTMLElement): void;
    reset(): void;
}

Hierarchy (View Summary)

Implemented by

Properties

addEventListener dispatchEvent id order removeEventListener

Methods

dispatchTypedEvent filter mount? reset?

Properties

addEventListener

addEventListener: <T extends string>(
    type: T,
    listener:
        | null
        | TypedEventListenerOrEventListenerObject<IFileListFilterEvents, T>,
    options?: boolean | AddEventListenerOptions,
) => void

Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

dispatchEvent

dispatchEvent: (event: Event) => boolean

Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

Deprecated

To ensure type safety use dispatchTypedEvent instead.

Readonlyid

id: string

Unique ID of this filter

Readonlyorder

order: number

Order of the filter

Use a low number to make this filter ordered in front.

removeEventListener

removeEventListener: <T extends string>(
    type: T,
    callback:
        | null
        | TypedEventListenerOrEventListenerObject<IFileListFilterEvents, T>,
    options?: boolean | EventListenerOptions,
) => void

Removes the event listener in target's event listener list with the same type, callback, and options.

Methods

dispatchTypedEvent

filter

Optionalmount

Optionalreset

  • reset(): void

  • Reset the filter to the initial state. This is called by the files app. Implementations should make sure,that if they provide chips they need to emit the update:chips event.

    Returns void

    Since

    3.10.0

Settings

Member Visibility

On This Page

Properties
Methods