@nextcloud/files
    Preparing search index...

    Interface IFileListFilterWithUi

    File list filter interface with UI component

    Filters with UI must provide additional information for rendering the filter component. The ui will be rendered depending on the view port - either as inline actions or in a dropdown menu.

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

    Hierarchy (View Summary)

    Index

    Properties

    addEventListener dispatchEvent displayName iconSvgInline id order removeEventListener tagName

    Methods

    dispatchTypedEvent filter reset?

    Properties

    addEventListener: <T extends string>(
        type: T,
        listener:
            | TypedEventListenerOrEventListenerObject<IFileListFilterEvents, T>
            | null,
        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: (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.

    To ensure type safety use dispatchTypedEvent instead.

    displayName: string

    Display name of the filter

    iconSvgInline: string

    Inline SVG icon as string for the filter

    id: string

    Unique ID of this filter

    order: number

    Order of the filter

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

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

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

    tagName: string

    Tag name of the web component to use as filter UI

    The web component must extend HTMLElement and accept a property filter of type IFileListFilterWithUi (it will receive the filter instance itself).

    https://developer.mozilla.org/en-US/docs/Web/Web_Components/Using_custom_elements

    Methods

    • Reset the filter to the initial state.

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

      Returns void

      3.10.0

    Settings

    Member Visibility

    On This Page

    Properties
    Methods