[OSCI] Added a console warning for panelled prop #1142
Conversation
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
Signed-off-by: Nishant Singhal <[email protected]>
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 <[email protected]>
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
| - 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 |
|
@NishantSinghal19 are you interested in continuing this? |
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.