Membrane SDK - v0.29.2
    Preparing search index...

    Interface FilterFieldMeta

    Metadata for Zod schema fields to configure filter behavior. Used with z.string().meta({ ... }) to annotate query schema fields.

    interface FilterFieldMeta {
        referenceElementType?: "self" | WorkspaceElementType;
        filterTitle?: string;
        hidden?: boolean;
        isFlag?: boolean;
        isDatetime?: boolean;
        useWorkspaceSearch?: boolean;
    }
    Index

    Properties

    referenceElementType? filterTitle? hidden? isFlag? isDatetime? useWorkspaceSearch?

    Properties

    referenceElementType?: "self" | WorkspaceElementType

    If this field references another workspace element, specify its type. The filter will render an appropriate element selector. Use 'self' to reference the same element type being filtered.

    filterTitle?: string

    Custom display title for the filter. If not provided, the field name will be used (converted to title case).

    hidden?: boolean

    Hide this field from filter options. Use for fields that are for API only, but not for UI

    isFlag?: boolean

    If true, this is a flag filter that doesn't have a value selector. It's either on or off - when selected, it sets the value to true.

    isDatetime?: boolean

    If true, this field is a datetime filter that shows a date picker. The value should be an ISO datetime string.

    useWorkspaceSearch?: boolean

    If true, use the workspace search endpoint (/search) instead of the element list API for the filter dropdown. Falls back to the element list API for empty searches.

    Settings

    Member Visibility

    On This Page

    Properties