From d53f46bfa6723eb1c2e80291be9b5f53e79567fb Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 6 Oct 2023 15:41:45 +0530 Subject: [PATCH 1/8] Documentation update for developer guide Signed-off-by: Nishant Singhal --- DEVELOPER_GUIDE.md | 16 ++++++++++++++-- 1 file changed, 14 insertions(+), 2 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 1f5cb18b75..9edaf92ede 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -16,10 +16,22 @@ We depend upon the version of node defined in [.nvmrc](.nvmrc). You will probably want to install a node version manager. [nvm](https://github.com/creationix/nvm) is recommended. -To install and use the correct node version with `nvm`: +To install and use the correct node version v with `nvm`: +v - verion mentioned in [.nvmrc](.nvmrc). ``` -nvm install +nvm install v +``` + +And then also set the node version to use in your terminal + +``` +nvm use v +``` + +Confirm the version of node by running: +``` +yarn node --version ``` ### Start documentation server From 6deaa3f56c7a007df601635454285ee957b095da Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 6 Oct 2023 15:43:12 +0530 Subject: [PATCH 2/8] Documentation update for developer guide Signed-off-by: Nishant Singhal --- DEVELOPER_GUIDE.md | 1 + 1 file changed, 1 insertion(+) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 9edaf92ede..1b885eab2e 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -17,6 +17,7 @@ We depend upon the version of node defined in [.nvmrc](.nvmrc). You will probably want to install a node version manager. [nvm](https://github.com/creationix/nvm) is recommended. To install and use the correct node version v with `nvm`: + v - verion mentioned in [.nvmrc](.nvmrc). ``` From 2243415c2dd94d0ddefcb8c00b7cbad805c0b3f4 Mon Sep 17 00:00:00 2001 From: Nishant Singhal <81030284+NishantSinghal19@users.noreply.github.com> Date: Sat, 7 Oct 2023 18:30:54 +0530 Subject: [PATCH 3/8] Update DEVELOPER_GUIDE.md Signed-off-by: Nishant Singhal <81030284+NishantSinghal19@users.noreply.github.com> --- DEVELOPER_GUIDE.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md index 1b885eab2e..d71a5fd200 100644 --- a/DEVELOPER_GUIDE.md +++ b/DEVELOPER_GUIDE.md @@ -18,16 +18,16 @@ You will probably want to install a node version manager. [nvm](https://github.c To install and use the correct node version v with `nvm`: -v - verion mentioned in [.nvmrc](.nvmrc). +v - version mentioned in [.nvmrc](.nvmrc). ``` -nvm install v +nvm install ``` And then also set the node version to use in your terminal ``` -nvm use v +nvm use ``` Confirm the version of node by running: From 3c0ff2f5caac457d865972b77d98ced7b8c03f19 Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 3 Nov 2023 22:29:36 +0530 Subject: [PATCH 4/8] Added Depreceation console msg Signed-off-by: Nishant Singhal --- src/components/page/page_body/page_body.tsx | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/components/page/page_body/page_body.tsx b/src/components/page/page_body/page_body.tsx index 5b4ea7af33..bb679282e5 100644 --- a/src/components/page/page_body/page_body.tsx +++ b/src/components/page/page_body/page_body.tsx @@ -36,6 +36,7 @@ import { setPropsForRestrictedPageWidth, } from '../_restrict_width'; import { OuiPanel, OuiPanelProps } from '../../panel'; +import { useDeprecatedPropWarning } from '../../../utils/deprecated'; const paddingSizeToClassNameMap = { none: null, @@ -61,6 +62,7 @@ export type OuiPageBodyProps = CommonProps & panelled?: boolean; /** * Extends any extra OuiPanel props if `panelled=true` + * **panelled prop is deprecated in version 2.0.0 */ panelProps?: Omit; /** @@ -111,6 +113,7 @@ export const OuiPageBody = ({ paddingSize={paddingSize} {...panelProps} {...rest}> + {useDeprecatedPropWarning({props:{panelled},version:'2.0.0'})} {children} ) : ( From 50f794c98ac09a0d5119a759b2c3e8c434559643 Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 3 Nov 2023 22:34:38 +0530 Subject: [PATCH 5/8] Add spaces Signed-off-by: Nishant Singhal --- src/components/page/page_body/page_body.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/page/page_body/page_body.tsx b/src/components/page/page_body/page_body.tsx index bb679282e5..d401d5f8ea 100644 --- a/src/components/page/page_body/page_body.tsx +++ b/src/components/page/page_body/page_body.tsx @@ -113,7 +113,7 @@ export const OuiPageBody = ({ paddingSize={paddingSize} {...panelProps} {...rest}> - {useDeprecatedPropWarning({props:{panelled},version:'2.0.0'})} + {useDeprecatedPropWarning({props:{ panelled },version:'2.0.0'})} {children} ) : ( From bac2efae8bbef53b38976a260d996f700ec881bb Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 3 Nov 2023 22:43:56 +0530 Subject: [PATCH 6/8] Add spaces Signed-off-by: Nishant Singhal --- src/components/page/page_body/page_body.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/page/page_body/page_body.tsx b/src/components/page/page_body/page_body.tsx index d401d5f8ea..2123737d67 100644 --- a/src/components/page/page_body/page_body.tsx +++ b/src/components/page/page_body/page_body.tsx @@ -113,7 +113,7 @@ export const OuiPageBody = ({ paddingSize={paddingSize} {...panelProps} {...rest}> - {useDeprecatedPropWarning({props:{ panelled },version:'2.0.0'})} + {useDeprecatedPropWarning({ props: { panelled }, version: '2.0.0' })} {children} ) : ( From 5c4924051070339433bab0b1e789d47818f471e9 Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 3 Nov 2023 23:08:57 +0530 Subject: [PATCH 7/8] Placed Hook Correctly Signed-off-by: Nishant Singhal --- src/components/page/page_body/page_body.tsx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/components/page/page_body/page_body.tsx b/src/components/page/page_body/page_body.tsx index 2123737d67..d4bdcee399 100644 --- a/src/components/page/page_body/page_body.tsx +++ b/src/components/page/page_body/page_body.tsx @@ -88,6 +88,7 @@ export const OuiPageBody = ({ style ); + useDeprecatedPropWarning({ props: { panelled }, version: '2.0.0' }); const nonBreakingDefaultPadding = panelled ? 'l' : 'none'; paddingSize = paddingSize || nonBreakingDefaultPadding; @@ -113,7 +114,6 @@ export const OuiPageBody = ({ paddingSize={paddingSize} {...panelProps} {...rest}> - {useDeprecatedPropWarning({ props: { panelled }, version: '2.0.0' })} {children} ) : ( From bc435cfe59500e392f84681bc6cb29a8898839bf Mon Sep 17 00:00:00 2001 From: Nishant Singhal Date: Fri, 3 Nov 2023 23:43:20 +0530 Subject: [PATCH 8/8] Update Changelog.md Signed-off-by: Nishant Singhal --- CHANGELOG.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index a3646ba851..cdf2ca7def 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -6,6 +6,8 @@ ### Deprecations +- Added useDeprecatedPropWarning for panelled prop ([#843](https://github.com/opensearch-project/oui/pull/1142)) + ### 🛡 Security ### 📈 Features/Enhancements