Skip to content

Commit a8fcae2

Browse files
authored
chore: add code comment about the "additionalLabel" usage in sidebar configs (#1207)
1 parent 4b3ad43 commit a8fcae2

2 files changed

Lines changed: 10 additions & 0 deletions

File tree

src/sidebar/integrations.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ const integrations: SidebarConfig = [
2626
{
2727
type: 'link',
2828
label: 'Enterprise connectors',
29+
/**
30+
* The "additionalLabel" prop is used in "Gallery" component where the sidebar config is used
31+
* to generate the gallery items. The additional label is appended to the label, in order to
32+
* provide additional information about the category.
33+
*/
2934
customProps: { additionalLabel: '(SP-initiated SSO)' },
3035
href: '#',
3136
className: 'sidebar-section',

src/sidebar/quick-start.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ const quickStartSidebar: SidebarConfig = [
2626
{
2727
type: 'link',
2828
label: 'Third-party apps',
29+
/**
30+
* The "additionalLabel" prop is used in "Gallery" component where the sidebar config is used
31+
* to generate the gallery items. The additional label is appended to the label, in order to
32+
* provide additional information about the category.
33+
*/
2934
customProps: { additionalLabel: '(Logto as Idp)' },
3035
href: '#',
3136
className: 'sidebar-section',

0 commit comments

Comments
 (0)