Website - CodeBlock height toggle docs
#2845
Merged
Conversation
This file contains hidden or 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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
dchyun
changed the title
CodeBlock toggle code docs
dchyun
changed the title
CodeBlock height toggle docs
dchyun
force-pushed
the
hds-4745-codeblock-height-toggle
branch
from
498b996 to
d992568
Compare
dchyun
force-pushed
the
dchyun/docs-code-block-toggle
branch
from
b679b47 to
f428cd6
Compare
jorytindall
reviewed
May 6, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
andgen404
reviewed
May 6, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
jorytindall
reviewed
May 7, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
andgen404
reviewed
May 7, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
andgen404
reviewed
May 7, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
jorytindall
previously approved these changes
May 7, 2025
shleewhite
previously approved these changes
May 9, 2025
shleewhite
previously approved these changes
May 13, 2025
jorytindall
previously approved these changes
May 13, 2025
website/docs/components/code-block/partials/guidelines/guidelines.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Jory Tindall <[email protected]>
jorytindall
previously approved these changes
May 13, 2025
jorytindall
previously approved these changes
May 13, 2025
jorytindall
approved these changes
May 14, 2025
shleewhite
approved these changes
May 14, 2025
| @@ -69,6 +69,21 @@ Line numbers are displayed by default and can make longer blocks of code and sni | |||
| In the Figma component, the code examples have the appropriate number of lines by default but must be manually hidden or shown to match the length of custom snippets. | |||
| !!! | |||
|
|
|||
| ## Height toggle button | |||
|
|
|||
| When displaying longer code snippets, it can be helpful to let users expand and collapse the content to save space in the UI. Setting a `maxHeight` on the Code Block limits how much is shown by default. If the content exceeds this height, a **Show more code** button will be displayed at the bottom of the block, allowing users to expand it. Interacting with the button again collapses the block back to its original height. | |||
There was a problem hiding this comment.
Working on tweaking this as it still seems a bit awkward... (I'll make a suggested edit)
| @@ -69,6 +69,21 @@ Line numbers are displayed by default and can make longer blocks of code and sni | |||
| In the Figma component, the code examples have the appropriate number of lines by default but must be manually hidden or shown to match the length of custom snippets. | |||
| !!! | |||
|
|
|||
| ## Height toggle button | |||
|
|
|||
| When displaying longer code snippets, it can be helpful to let users expand and collapse the content to save space in the UI. Setting a `maxHeight` on the Code Block limits how much is shown by default. If the content exceeds this height, a **Show more code** button will be displayed at the bottom of the block, allowing users to expand it. Interacting with the button again collapses the block back to its original height. | |||
There was a problem hiding this comment.
Suggested change
| When displaying longer code snippets, it can be helpful to let users expand and collapse the content to save space in the UI. Setting a `maxHeight` on the Code Block limits how much is shown by default. If the content exceeds this height, a **Show more code** button will be displayed at the bottom of the block, allowing users to expand it. Interacting with the button again collapses the block back to its original height. | |
| For longer code content, it can be helpful to set a `maxHeight` for the Code Block to limit how much code is shown by default within the UI layout. If the content exceeds this height, a “Show more code” button will be displayed at the bottom of the Code Block, allowing users to expand it. Activating this button again will collapse the content back to its original height. |
There was a problem hiding this comment.
@andgen404 How's this? (Above suggested edit)
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.
📌 Summary
This PR adds docs to the website for the new
CodeBlocktoggle button from #2826.Preview link
🔗 External links
Jira ticket: HDS-4745
💬 Please consider using conventional comments when reviewing this PR.