Add story parameters to the item via the renderLabel function

[mririgoyen]

Is your feature request related to a problem? Please describe.

I need to be able to conditionally add status icons to my Component names. I thought I could easily do this utilizing the renderLabel function for the sidebar, however the item that is available is quite limited in the information that it has available. According to the Storybook docs, "Parameters are a set of static, named metadata about a story, typically used to control the behavior of Storybook features and addons." However, I cannot access these in the addon config to actually utilize them.

Describe the solution you'd like

I would like to be able to access the parameters for each item in the renderLabel function, so that I can make rendering decisions on the title. For example:

import { addons } from '@storybook/manager-api';
import Icon from '@mdi/react';
import { mdiAccountCircle, mdiServer } from '@mdi/js';

addons.setConfig({
  sidebar: {
    // Access "parameters" as part of the item here
    renderLabel: ({ name, parameters, type }) => {
      // Only add icons to components
      if (type !== 'component') {
        return name;
      }
      
      // Get my custom parameter from the story metadata
      const { componentType } = parameters;
      
      // Only add icons if a componentType is specified
      if (!['client', 'server'].includes(componentType)) {
        return name;
      }

      const icon = componentType === 'server' ? mdiServer : mdiAccountCircle;
      return <>{name} <Icon path={icon} size={1} />;
    },
  },
});

Describe alternatives you've considered

I've tried to use a custom storyIndexers function in main.ts, but no matter how I configure it, it never matches any files.

Are you able to assist to bring the feature to reality?

no

Additional context

No response

[awreese]

I second this request.

Interestingly enough it seems that there should/could be a parameters property for certain item types since there's an interface/type declared with it. I don't see parameters on API_ComponentEntry though, which is what it seems @mririgoyen is asking for.

storybook/code/core/src/types/modules/api-stories.ts

Lines 26 to 65 in 2ebbeed

	export interface API_ComponentEntry extends API_BaseEntry {
	type: 'component';
	parent?: StoryId;
	children: StoryId[];
	}
	export interface API_DocsEntry extends API_BaseEntry {
	type: 'docs';
	parent: StoryId;
	title: ComponentTitle;
	importPath: Path;
	tags: Tag[];
	prepared: boolean;
	parameters?: {
	[parameterName: string]: any;
	};
	}
	export interface API_StoryEntry extends API_BaseEntry {
	type: 'story';
	parent: StoryId;
	title: ComponentTitle;
	importPath: Path;
	tags: Tag[];
	prepared: boolean;
	parameters?: {
	[parameterName: string]: any;
	};
	args?: Args;
	argTypes?: ArgTypes;
	initialArgs?: Args;
	}
	export type API_LeafEntry = API_DocsEntry | API_StoryEntry;
	export type API_HashEntry =
	| API_RootEntry
	| API_GroupEntry
	| API_ComponentEntry
	| API_DocsEntry
	| API_StoryEntry;

But in the current code I have (SB v8) the parameters property is not passed through and just simply undefined.