Documentation
    Preparing search index...

    Class AssetActiveCategoryRendererPluginInternal

    Plugin that handles the active categories for the asset preview. It is responsible for managing the state of the active categories and persisting it to the URL query, as well as syncing it with the layer manager.

    Hierarchy

    • RendererPluginBase<Events>
      • AssetActiveCategoryRendererPlugin

    Implements

    • StatefulRendererPlugin<typeof assetActiveCategoryRendererPluginStore>
    Index

    Constructors

    Properties

    emitter: Emitter<Events> = ...

    An event emitter for handling custom events.

    Methods

    • Adds an event listener for a specific event.

      Type Parameters

      • K extends keyof Events

        The type of the event key.

      Parameters

      • event: K

        The event to listen to.

      • listener: (eventData: Events[K]) => void

        The callback function to be invoked when the event is emitted.

      Returns { remove: () => void }

      An object with a remove method to unsubscribe the listener.

    • Registers an event listener handle to be managed by the plugin. Managed listeners will be automatically removed when the plugin is torn down.

      Parameters

      • handle: { remove: () => void } | (() => void)

        The event listener handle to manage.

      Returns void

    • Returns Write<
          WithCompute<WithDevtools<StoreApi<Store>>, ComputedStore>,
          StoreSubscribeWithSelector<Store & ComputedStore>,
      >

      Don't use this method to get store directly. Use Plugin API instead.

    • Tears down the plugin by removing all managed event listeners and clearing the event emitter. This method is called when the plugin is being destroyed.

      Parameters

      • _context: RendererPluginContext

        The plugin context provided during teardown.

      Returns void