Add docs for list heading #4544
Merged
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
Valid values for ListHeading's `maxLines` prop are 1 and 2. When the provided value is invalid, fallback to a value of 1, and console.warn the user.
|
This pull request is being automatically deployed with Vercel (learn more). 🔍 Inspect: https://vercel.com/uber-ui-platform/baseweb/2LMXohuVrbQX4qJUpAJ2gP2RagTU |
|
This pull request is automatically built and testable in CodeSandbox. To see build info of the built libraries, click here or the icon next to each commit SHA. Latest deployment of this branch, based on commit e2d00f7:
|
lhbrennan
requested review from
chasestarr,
tajo and
williamernest
as code owners
chasestarr
approved these changes
Sep 24, 2021
src/list/list-heading.js
Outdated
| @@ -78,6 +82,9 @@ const ListHeading = React.forwardRef<HeadingPropsT, HTMLLIElement>( | |||
| 'endEnhancerDescription will not be rendered if endEnhancer is not a string', | |||
| ); | |||
| } | |||
| if (maxLines && !isMaxLinesValid(maxLines)) { | |||
There was a problem hiding this comment.
Nit: Can we wrap this is a __DEV__ if statement, maybe do the same for isEndEnhancerString check?
There was a problem hiding this comment.
Good catch, thanks.
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.
Description
Extend the docs page for
listto includeListHeading.