Skip to content

ToC optional prefix/suffice params added #1956

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

Merged
merged 4 commits into from
Aug 28, 2023
Merged

ToC optional prefix/suffice params added #1956

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2f917a1
ToC Prefix and Suffix params added
endigo9740 Aug 28, 2023
bbd303a
ToC Prefix and Suffix params added
endigo9740 Aug 28, 2023
a0cb58a
Changeset added
endigo9740 Aug 28, 2023
9c98d16
fixed `-` placement for suffix
AdrianGonz97 Aug 28, 2023
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
5 changes: 5 additions & 0 deletions .changeset/tall-jobs-wait.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@skeletonlabs/skeleton": patch
---

chore: Update Table of Contents to include optional `prefix` and `suffix` parameters
8 changes: 7 additions & 1 deletion packages/skeleton/src/lib/utilities/TableOfContents/crawler.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ interface TOCCrawlerArgs {
scrollTarget?: string;
/** Reload the action when this key value changes. */
key?: unknown;
/* Provide a prefix for ToC links, to help keep them unique. */
prefix?: string;
/* Provide a suffix for ToC links, to help keep them unique. */
suffix?: string;
}

export function tocCrawler(node: HTMLElement, args?: TOCCrawlerArgs) {
Expand Down Expand Up @@ -44,7 +48,9 @@ export function tocCrawler(node: HTMLElement, args?: TOCCrawlerArgs) {
.replaceAll(/[^a-zA-Z0-9 ]/g, '')
.replaceAll(' ', '-')
.toLowerCase();
elemHeading.id = `toc-${newHeadingId}`;
const prefix = args.prefix ? `${args.prefix}-` : '';
const suffix = args.suffix ? `-${args.suffix}` : '';
elemHeading.id = prefix + newHeadingId + suffix;
}
// Push heading data to the permalink array
permalinks.push({
Expand Down
3 changes: 2 additions & 1 deletion sites/skeleton.dev/src/routes/(inner)/elements/chat/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -473,7 +473,8 @@ let messageFeed = [
</section>

<section class="space-y-4">
<h2 class="h2">Prompt</h2>
<!-- NOTE: id provided to avoid ToC conflict -->
<h2 class="h2" id="prompt-field">Prompt</h2>
<p>
We can utilize a Skeleton <a class="anchor" href="/elements/forms">Input Group</a> to create a custom text prompt.
</p>
Expand Down
16 changes: 15 additions & 1 deletion sites/skeleton.dev/src/routes/(inner)/utilities/table-of-contents/+page.svelte
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,24 @@
code={`
<!-- Before: -->
<h2 class="h2">Title One</h2>
<h2 class="h2" id="toc-my-custom-id">Title Two</h2>\n
<h2 class="h2" id="my-custom-id">Title Two</h2>\n
<!-- After: -->
<h2 class="h2" id="title-one">Title One</h2>
<h2 class="h2" id="my-custom-id">Title Two</h2>
`}
/>
<!-- Prefixes and Suffixes -->
<h3 class="h3">Prefixes and Suffixes</h3>
<!-- prettier-ignore -->
<p>
We recommend setting a custom heading (per the instruction above) if a conflict is found within your page. However, you may also hardcode a <code class="code">prefix</code> or <code class="code">suffix</code> to all generated IDs as follows:
</p>
<CodeBlock
language="html"
code={`
<div use:tocCrawler={{ mode: 'generate', prefix: 'foo', suffix: 'bar' }}>\n
<!-- Ex: foo-title-one-bar -->
<!-- Ex: foo-title-two-bar -->
`}
/>
<!-- Ignore Headings -->
Expand Down