[TreeView] Add utility function to check if an optional plugin is pre…

…sent (#13788)

packages/x-tree-view/src/internals/corePlugins/corePlugins.ts

@@ -1,12 +1,17 @@
 import { useTreeViewInstanceEvents } from './useTreeViewInstanceEvents';
+import { useTreeViewOptionalPlugins } from './useTreeViewOptionalPlugins';
 import { useTreeViewId, UseTreeViewIdParameters } from './useTreeViewId';
 import { ConvertPluginsIntoSignatures } from '../models';
 
 /**
  * Internal plugins that create the tools used by the other plugins.
  * These plugins are used by the tree view components.
  */
-export const TREE_VIEW_CORE_PLUGINS = [useTreeViewInstanceEvents, useTreeViewId] as const;
+export const TREE_VIEW_CORE_PLUGINS = [
+ useTreeViewInstanceEvents,
+ useTreeViewOptionalPlugins,
+ useTreeViewId,
+] as const;
 
 export type TreeViewCorePluginSignatures = ConvertPluginsIntoSignatures<
  typeof TREE_VIEW_CORE_PLUGINS

packages/x-tree-view/src/internals/corePlugins/useTreeViewOptionalPlugins/index.ts

@@ -0,0 +1,2 @@
+export { useTreeViewOptionalPlugins } from './useTreeViewOptionalPlugins';
+export type { UseTreeViewOptionalPluginsSignature } from './useTreeViewOptionalPlugins.types';

packages/x-tree-view/src/internals/corePlugins/useTreeViewOptionalPlugins/useTreeViewOptionalPlugins.ts

@@ -0,0 +1,17 @@
+import { TreeViewPlugin } from '../../models';
+import { UseTreeViewOptionalPluginsSignature } from './useTreeViewOptionalPlugins.types';
+
+export const useTreeViewOptionalPlugins: TreeViewPlugin<UseTreeViewOptionalPluginsSignature> = ({
+ plugins,
+}) => {
+ const pluginSet = new Set(plugins);
+ const getAvailablePlugins = () => pluginSet;
+
+ return {
+ instance: {
+ getAvailablePlugins,
+ },
+ };
+};
+
+useTreeViewOptionalPlugins.params = {};

packages/x-tree-view/src/internals/corePlugins/useTreeViewOptionalPlugins/useTreeViewOptionalPlugins.types.ts

@@ -0,0 +1,9 @@
+import { TreeViewPlugin, TreeViewAnyPluginSignature, TreeViewPluginSignature } from '../../models';
+
+interface UseTreeViewOptionalPluginsInstance {
+ getAvailablePlugins: () => Set<TreeViewPlugin<TreeViewAnyPluginSignature>>;
+}
+
+export type UseTreeViewOptionalPluginsSignature = TreeViewPluginSignature<{
+ instance: UseTreeViewOptionalPluginsInstance;
+}>;

packages/x-tree-view/src/internals/models/plugin.ts

@@ -16,6 +16,7 @@ export interface TreeViewPluginOptions<TSignature extends TreeViewAnyPluginSigna
  models: TreeViewUsedModels<TSignature>;
  setState: React.Dispatch<React.SetStateAction<TreeViewUsedState<TSignature>>>;
  rootRef: React.RefObject<HTMLUListElement>;
+ plugins: TreeViewPlugin<TreeViewAnyPluginSignature>[];
 }
 
 type TreeViewModelsInitializer<TSignature extends TreeViewAnyPluginSignature> = {

packages/x-tree-view/src/internals/useTreeView/useTreeView.ts

@@ -157,6 +157,7 @@ export const useTreeView = <
  setState,
  rootRef: innerRootRef,
  models,
+ plugins,
  });
 
  if (pluginResponse.getRootProps) {

packages/x-tree-view/src/internals/utils/plugins.ts

@@ -0,0 +1,12 @@
+import { TreeViewAnyPluginSignature, TreeViewInstance, TreeViewPlugin } from '../models';
+
+export const hasPlugin = <
+ TSignature extends TreeViewAnyPluginSignature,
+ TInstance extends TreeViewInstance<[], [TSignature]>,
+>(
+ instance: TInstance,
+ plugin: TreeViewPlugin<TSignature>,
+): instance is Omit<TInstance, keyof TSignature['instance']> & TSignature['instance'] => {
+ const plugins = instance.getAvailablePlugins();
+ return plugins.has(plugin as any);
+};