feat: adding a flag to ColorPicker for showing color name tooltips #629
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
laviomri
approved these changes
Apr 7, 2022
src/components/ColorPicker/components/ColorPickerContent/ColorPickerColorsGrid.jsx
Outdated
Show resolved
Hide resolved
| @@ -159,7 +162,8 @@ ColorPickerContentComponent.defaultProps = { | |||
| * Used to force the component render the colorList prop as is. Usually, this flag should not be used. It's intended only for edge cases. | |||
| * Usually, only "monday colors" will be rendered (unless blacklist mode is used). This flag will override this behavior. | |||
| */ | |||
| forceUseRawColorList: false | |||
| forceUseRawColorList: false, | |||
| showColorNameTooltip: false | |||
There was a problem hiding this comment.
please add description for the new prop.
Also, if it's incompatible with forceUseRawColorList, please mention it.
(by the way - why is it incompatible? 🤔 )
And lastly, consider explaining what happens if tooltipContentByColor is supplied while showColorNameTooltip is truthy (tooltipContentByColor will take precendence)
There was a problem hiding this comment.
@laviomri it's incompatible with forceUseRawColorList cause it relies on the color structure (that it has name)
| @@ -21,12 +21,26 @@ export const ColorPickerColorsGrid = React.forwardRef( | |||
| SelectedIndicatorIcon, | |||
| colorSize, | |||
| tooltipContentByColor, | |||
| colorShape | |||
| colorShape, | |||
| showColorNameTooltip: showColorNameTooltip | |||
There was a problem hiding this comment.
Suggested change
| showColorNameTooltip: showColorNameTooltip | |
| showColorNameTooltip |
hadasfa
reviewed
Apr 7, 2022
| @@ -97,7 +99,8 @@ ColorPicker.propTypes = { | |||
| numberOfColorsInLine: PropTypes.number, | |||
| focusOnMount: PropTypes.bool, | |||
| colorShape: PropTypes.oneOf(Object.values(ColorPicker.colorShapes)), | |||
| forceUseRawColorList: PropTypes.bool | |||
| forceUseRawColorList: PropTypes.bool, | |||
| showColorNameTooltip: PropTypes.bool | |||
There was a problem hiding this comment.
let's add also a description here for the storybook docs
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: adding a flag to ColorPicker for showing color name tooltips
Basic
npm run plop) to create a new component.PropTypes.Style
NewComponent.modules.scssfile inside of theNewComponentfolder.Storybook
/src/NewComponent/__stories__/NewComponent.stories.jsfile.Tests