oui icon indicating copy to clipboard operation
oui copied to clipboard

Deprecate `panelled` prop of `OuiPageBody`

Open joshuarrrr opened this issue 2 years ago • 3 comments

@KrooshalUX would prefer to simplify layout guidance and variability by removing this as an option. We can also do a global code search to check for existing usage.

See also https://github.com/opensearch-project/oui/issues/840

joshuarrrr avatar Jun 22 '23 18:06 joshuarrrr

Adding useDeprecatedProps will create log messages where it's used. That can help find some high impact areas

BSFishy avatar Jun 22 '23 18:06 BSFishy

This work consists of 3 parts:

  1. Insert the useDeprecatedProps hook to generate a console.log message when the prop is used: https://github.com/opensearch-project/oui/blob/1fe770cc662888be2d497da7352d6bf6f4f26cc4/src/utils/deprecated/deprecated.tsx#L56 You can say it will be removed in 2.0.0 (specify the prop version: '2.0.0')
  2. Add a deprecation comment to the prop that says this prop is deprecated and will be removed in version 2.0

If you need any more info or get stuck, feel free to ping me.

Edit: It looks like there isn't any docsite section that discusses this, so only these two are needed

BSFishy avatar Sep 29 '23 17:09 BSFishy

@BSFishy can you please assign me this issue

NishantSinghal19 avatar Sep 30 '23 05:09 NishantSinghal19