Create docs-ui package with LinkableHeading component #1401
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 752ec55 The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
michaeltaranto
approved these changes
Nov 27, 2023
Merged
mrm007
reviewed
Nov 27, 2023
| | --------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | level | [`HeadingLevel`] | The heading size (defaults to `3`) | | ||
| | component | `string` | HTML element to render, e.g. “h1”, “h2”, etc. | | ||
| | children | `string` | Visible heading content, converted to slug (e.g. “section-heading”) to be used as hash link.<br/>Note: If the heading | |
There was a problem hiding this comment.
Oh whoops, will add the fix in the follow up PR
mrm007
reviewed
Nov 27, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This package is to house components for building docs sites like Braid. It is intended to be used by other sites with a similar layout and UX to the Braid site.
There will be a follow up PR to remove the 'LinkableHeading' component from the
braid-design-systempackage and replace all usages with the component from thedocs-uipackage.