Skip to content

fix : added logic to handle branches #2905

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SB-virendrasolanke wants to merge 1 commit into
base: main
Choose a base branch
from
Open

fix : added logic to handle branches #2905

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/src/components/BranchSelector/BranchSelector.stories.tsx
View file
Open in desktop
Copy link
Copy Markdown
Contributor Author

@SB-virendrasolanke SB-virendrasolanke Apr 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ignore the config, later after testing I will revert these files to originals.

Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ export default {
platformUrl: { table: { category: 'Input' } },
},
args: {
projectId: 'cHJqOjYwNjYx',
platformUrl: 'https://stoplight.io',
projectId: 'cHJqOjMwODc1MA',
platformUrl: 'https://persistentteams.stoplight.io',
},
};

Expand Down
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/src/components/NodeContent/NodeContent.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,9 @@ export default {
},
args: {
nodeSlug: 'b3A6Mzg5NDM2-create-todo',
projectId: 'cHJqOjYwNjYx',
projectId: 'cHJqOjMwODc1MA',
branchSlug: '',
platformUrl: 'https://stoplight.io',
platformUrl: 'https://persistentteams.stoplight.io',
},
};

Expand Down
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/src/components/Search/Search.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -136,9 +136,9 @@ export default {
isInResponsiveMode: { table: { category: 'Input' } },
},
args: {
projectIds: ['cHJqOjYwNjYx'],
projectIds: ['cHJqOjMwODc1MA'],
workspaceId: 'd2s6NDE1NTU',
platformUrl: 'https://stoplight.io',
platformUrl: 'https://persistentteams.stoplight.io',
isInResponsiveMode: false,
},
};
Expand Down
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/src/components/TableOfContents/TableOfContents.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,9 +51,9 @@ export default {
isInResponsiveMode: { table: { category: 'Input' } },
},
args: {
projectId: 'cHJqOjYwNjYx',
projectId: 'cHJqOjMwODc1MA',
branchSlug: '',
platformUrl: 'https://stoplight.io',
platformUrl: 'https://persistentteams.stoplight.io',
isInResponsiveMode: false,
},
};
Expand Down
6 changes: 3 additions & 3 deletions packages/elements-dev-portal/src/containers/StoplightProject.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,13 +16,13 @@ export default {
},
args: {
router: 'memory',
platformUrl: 'https://stoplight.io',
platformUrl: 'https://persistentteams.stoplight.io',
},
};

export const Playground: Story<StoplightProjectProps> = args => <StoplightProject {...args} />;
Playground.storyName = 'Studio Demo';
Playground.args = {
projectId: 'cHJqOjYwNjYx',
platformUrl: 'https://stoplight.io',
projectId: 'cHJqOjMwODc1MA',
platformUrl: 'https://persistentteams.stoplight.io',
};
15 changes: 14 additions & 1 deletion packages/elements-dev-portal/src/containers/StoplightProject.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -120,6 +120,19 @@ const StoplightProjectImpl: React.FC<StoplightProjectProps> = ({ projectId, coll

const container = React.useRef<HTMLDivElement>(null);

// Create a custom Link component that preserves the branch path
const BranchAwareLink = React.useMemo(() => {
return React.forwardRef<HTMLAnchorElement, React.ComponentProps<typeof Link>>((props, ref) => {
const { to, ...rest } = props;
// If we're on a branch, prefix all relative links with the branch path
// Only modify relative paths (not starting with /, #, http://, https://, or .)
const shouldPrefixBranch = branchSlug && typeof to === 'string' && to !== '.' && !/^(\/|#|https?:\/\/)/.test(to);

const adjustedTo = shouldPrefixBranch ? `branches/${encodeURIComponent(branchSlug)}/${to}` : to;
return <Link ref={ref} to={adjustedTo} {...rest} />;
});
}, [branchSlug]);

if (!nodeSlug && isTocFetched && tableOfContents?.items) {
const firstNode = findFirstNode(tableOfContents.items);
if (firstNode) {
Expand Down Expand Up @@ -152,7 +165,7 @@ const StoplightProjectImpl: React.FC<StoplightProjectProps> = ({ projectId, coll
<TableOfContents
activeId={node?.id || nodeSlug?.split('-')[0] || ''}
tableOfContents={tableOfContents}
Link={Link as CustomLinkComponent}
Link={BranchAwareLink as CustomLinkComponent}
collapseTableOfContents={collapseTableOfContents}
onLinkClick={handleTocClick}
/>
Expand Down
4 changes: 2 additions & 2 deletions packages/elements-dev-portal/src/web-components/__stories__/StoplightProject.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,6 @@ export default {
export const defaultProject = Template.bind({});
defaultProject.storyName = "Stoplight's Demo workspace";
defaultProject.args = {
projectId: 'cHJqOjYwNjYx',
platformUrl: 'https://stoplight.io',
projectId: 'cHJqOjMwODc1MA',
platformUrl: 'https://persistentteams.stoplight.io',
};