[OSCI] Added a console warning for panelled prop #1142
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
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
Signed-off-by: Nishant Singhal <81030284+NishantSinghal19@users.noreply.github.com>
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
NishantSinghal19
requested review from
seanneumann,
AMoo-Miki,
rednaksi91,
KrooshalUX,
BSFishy,
bandinib-amzn,
ashwin-pc,
joshuarrrr,
andreymyssak and
SergeyMyssak
as code owners
Signed-off-by: Nishant Singhal <nishantsinghal900@gmail.com>
joshuarrrr
requested changes
Nov 14, 2023
There was a problem hiding this comment.
Thanks @NishantSinghal19 ! We should mark both panelled and panelProps as deprecated, and have a comment for each.
| @@ -61,6 +62,7 @@ export type OuiPageBodyProps<T extends ComponentTypes = 'main'> = CommonProps & | |||
| panelled?: boolean; | |||
| /** | |||
| * Extends any extra OuiPanel props if `panelled=true` | |||
| * **panelled prop is deprecated in version 2.0.0 | |||
There was a problem hiding this comment.
This is comment is on the wrong line - comments precede the props, so the comments for the panelled prop are L59-61.
| @@ -86,6 +88,7 @@ export const OuiPageBody = <T extends ComponentTypes>({ | |||
| style | |||
| ); | |||
|
|
|||
| useDeprecatedPropWarning({ props: { panelled }, version: '2.0.0' }); | |||
There was a problem hiding this comment.
I think we should also include panelProps as a deprecated prop, because it's dependent on panelled being true.
| @@ -6,6 +6,8 @@ | |||
|
|
|||
| ### Deprecations | |||
|
|
|||
| - Added useDeprecatedPropWarning for panelled prop ([#843](https://github.com/opensearch-project/oui/pull/1142)) | |||
There was a problem hiding this comment.
nit - use imperative for changelog entries, and link to the PR, not the issue
Suggested change
| - Added useDeprecatedPropWarning for panelled prop ([#843](https://github.com/opensearch-project/oui/pull/1142)) | |
| - Add deprecation warning for `panelled` prop of `OuiPageBody` ([#1142](https://github.com/opensearch-project/oui/pull/1142)) |
|
@NishantSinghal19 Just checking in to see if you'll be able to make the last couple changes requested. |
|
Ohh sorry I will do this by EOD |
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
I have added the
useDepreceatedPropWarningfor thepanelledprop which is going to be depreciated in ver 2.0Issues Resolved
I have solved issue #843 which was assigned to me
Check List
yarn lintyarn test-unitBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.