• English

      • CollectionFilterPanel

      CollectionFilterPanel is used to embed a Collection filter panel in a page.

      Basic Usage

      import { CollectionFilterPanel, type CollectionFilterPanelRef } from '@nocobase/client-v2';

const ref = useRef<CollectionFilterPanelRef>(null);

<CollectionFilterPanel ref={ref} collection={collection} t={t} />;

const filter = ref.current?.getFilter();

      API

      PropTypeDescription
      collection`Collectionundefined`
      initialValueRecord<string, unknown>Initial filter value
      onChange(filter) => voidChange callback
      t(key, options?) => stringTranslation function
      filterableFieldNamesstring[]Field allowlist
      nonfilterableFieldNamesstring[]Field blocklist
      noIgnorebooleanSkip allowlist restrictions

      Methods

      MethodDescription
      getFilter()Get the compiled filter
      reset()Clear all conditions