ColorPicker style prop deprecation #2444
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
Inbal-Tish
reviewed
Feb 2, 2023
src/components/colorPicker/index.tsx
Outdated
| super(props); | ||
|
|
||
| if (props.style) { | ||
| LogService.warn('UILib ColorPicker style prop is deprecated.'); |
There was a problem hiding this comment.
Suggested change
| LogService.warn('UILib ColorPicker style prop is deprecated.'); | |
| LogService.warn('UILib ColorPicker style prop is deprecated. Please stop using it.'); |
There was a problem hiding this comment.
You should also tell the user what to do, otherwise, they will ask if there is another prop that replaces it etc.
Inbal-Tish
reviewed
Feb 2, 2023
src/components/colorPicker/index.tsx
Outdated
|
|
||
| state = { | ||
| show: false | ||
| }; | ||
|
|
||
| static defaultProps = { |
There was a problem hiding this comment.
We keep the statics up after the static displayName
Inbal-Tish
reviewed
Feb 2, 2023
Inbal-Tish
reviewed
Feb 6, 2023
| {"name": "style", "type": "ViewStyle", "description": "Component's style"}, | ||
| {"name": "testID", "type": "string", "description": "The test id for e2e tests"} | ||
| {"name": "testID", "type": "string", "description": "The test id for e2e tests"}, | ||
| {"name": "backgroundColor", "type": "string", "description": "Give the ColorPicker a background color"} |
There was a problem hiding this comment.
Please change "Give the ColorPicker a background color" to "The ColorPicker's/Component's background color"
…ound prop description in the ColorPicker component
Inbal-Tish
reviewed
Feb 9, 2023
| @@ -38,7 +38,8 @@ | |||
| {"name": "containerWidth", "type": "number", "description": "The container margins"}, | |||
| {"name": "containerStyle", "type": "ViewStyle", "description": "Component's container style"}, | |||
| {"name": "style", "type": "ViewStyle", "description": "Component's style"}, | |||
| {"name": "testID", "type": "string", "description": "The test id for e2e tests"} | |||
| {"name": "testID", "type": "string", "description": "The test id for e2e tests"}, | |||
| {"name": "backgroundColor", "type": "string", "description": "The ColorPalette background color"} | |||
There was a problem hiding this comment.
Suggested change
| {"name": "backgroundColor", "type": "string", "description": "The ColorPalette background color"} | |
| {"name": "backgroundColor", "type": "string", "description": "The ColorPalette's background color"} |
Inbal-Tish
reviewed
Feb 9, 2023
| @@ -54,7 +54,7 @@ interface Props { | |||
| style?: StyleProp<ViewStyle>; | |||
| testID?: string; | |||
| /** | |||
| * Give the ColorPalette a background color | |||
| * Give the ColorPalette background color | |||
There was a problem hiding this comment.
Suggested change
| * Give the ColorPalette background color | |
| * The ColorPicker's background color |
Inbal-Tish
reviewed
Feb 9, 2023
src/components/colorPicker/index.tsx
Outdated
| super(props); | ||
|
|
||
| if (props.style) { | ||
| LogService.warn(`UILib ColorPicker style prop is deprecated, please pass instead the 'backgroundColor' prop.`); |
There was a problem hiding this comment.
Suggested change
| LogService.warn(`UILib ColorPicker style prop is deprecated, please pass instead the 'backgroundColor' prop.`); | |
| LogService.warn(`UILib ColorPicker's 'style' prop is deprecated. You can use the 'backgroundColor' prop instead`); |
Inbal-Tish
approved these changes
Feb 9, 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.
Description
ColorPicker style prop deprecation.
Changelog
ColorPicker style prop deprecation.