Provide the "item" parameter of the "renderLabel" method with the data type belonging to the page

[oliverschuerch]

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

The API_SidebarOption interface specifies what to expect from the method renderLabel, its parameter and return value when used within the manager config (manager.ts):

export interface API_SidebarOptions {
  showRoots?: boolean;
  filters?: Record<string, API_FilterFunction>;
  collapsedRoots?: string[];
  renderLabel?: (item: API_HashEntry) => any;
}

You can see, that the given parameter will by of type API_HashEntry which has some sub types:

type API_HashEntry = API_RootEntry | API_GroupEntry | API_ComponentEntry | API_DocsEntry | API_StoryEntry;

All the sub types of API_HashEntry do extend the API_BaseEntry interface:

interface API_BaseEntry {
    id: StoryId;
    depth: number;
    name: string;
    refId?: string;
    renderLabel?: (item: API_BaseEntry) => any;
    /** @deprecated */
    isRoot: boolean;
    /** @deprecated */
    isComponent: boolean;
    /** @deprecated */
    isLeaf: boolean;
}

There you can clearly see, that the given method parameter of the renderLabel method differs from the one before. The item parameter is always of type API_BaseEntry.

The problem with this is, that if you use the renderLabel method in the manager config, you'd expect that you will get (for example) an item parameter of type API_DocsEntry when the label is for a docs page. Same as you'd expect, that the parameter is of type API_StoryEntry, when the label is for story page.

Describe the solution you'd like

I'd expect, that the item parameter of the renderLabel method would contain a specific, correctly typed item, dependant of the page the label is for:

• item type of a label which leads to a root page: API_RootEntry
  ...
• item type of a label which leads to a docs page: API_DocsEntry
• item type of a label which leads to a story page: API_StoryEntry

If this can be realized, users should be able to use tags, parameters and other properties defined in the story or meta object of a story, to render the label for it.

Describe alternatives you've considered

No response

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

no

Additional context

This would also fix the following issue: #25998

[oliverschuerch]

May be a duplicate of #24022