Skip to content

Rename table of contents component class#3650

Merged
rmccar merged 4 commits intomainfrom
update-toc-class-names
Sep 8, 2025
Merged

Rename table of contents component class#3650
rmccar merged 4 commits intomainfrom
update-toc-class-names

Conversation

@admilne
Copy link
Copy Markdown
Contributor

@admilne admilne commented Jun 25, 2025

What is the context of this PR?

BREAKING CHANGE
Ticket: ONSDESYS-203
Fixes: #3430

Updates class names using toc to table-of-contents

PR #3424 updated the table of contents files to remove the toc acronym but changing the ons-js-toc-container class was considered a breaking change due to some documentation which instructs users to set the class on a div to contain the table of contents in some instances. This PR updates that class name so we can group the breaking changes together.

This will impact the table of contents component and any page that is going to use it

To mitigate the breaking change:

Update any references of the ons-js-toc-container class to ons-js-table-of-contents-container.

How to review this PR

  • Pull down the code and search for the class name ons-js-toc-container. There should be none remaining within the codebase

Checklist

This needs to be completed by the person raising the PR.

  • I have selected the correct Assignee
  • I have linked the correct Issue

@admilne admilne self-assigned this Jun 25, 2025
@admilne admilne requested a review from a team as a code owner June 25, 2025 15:20
@admilne admilne added Enhancement Change of existing feature Breaking changes This PR contains at least one breaking change labels Jun 25, 2025
@netlify
Copy link
Copy Markdown

netlify bot commented Jun 25, 2025

Deploy Preview for ons-design-system-preview ready!

Name Link
🔨 Latest commit ce40529
🔍 Latest deploy log https://app.netlify.com/projects/ons-design-system-preview/deploys/68beaaa1acab580008d3f8b0
😎 Deploy Preview https://deploy-preview-3650--ons-design-system-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@admilne admilne removed the Enhancement Change of existing feature label Jun 26, 2025
@rmccar rmccar merged commit 8438796 into main Sep 8, 2025
14 checks passed
@rmccar rmccar deleted the update-toc-class-names branch September 8, 2025 11:05
@rmccar rmccar changed the title Replace 'toc' in class names with 'table-of-contents' Rename table of contents component class Sep 8, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Breaking changes This PR contains at least one breaking change

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update ons-js-toc-container class name to align with other class naming standard

4 participants