From 286a2e83faf798cbe205087ad01e311519a8bf48 Mon Sep 17 00:00:00 2001 From: "Alex.hxy" <1872591453@qq.com> Date: Fri, 27 Dec 2024 17:57:40 +0800 Subject: [PATCH 1/2] chore: deprecated component help --- src/packages/sidenavbar/doc.en-US.md | 2 ++ src/packages/sidenavbar/doc.md | 2 ++ src/packages/sidenavbar/doc.taro.md | 3 ++- src/packages/sidenavbar/doc.zh-TW.md | 2 ++ src/packages/sidenavbar/sidenavbar.taro.tsx | 11 +++++++++-- src/packages/sidenavbar/sidenavbar.tsx | 11 +++++++++-- 6 files changed, 26 insertions(+), 5 deletions(-) diff --git a/src/packages/sidenavbar/doc.en-US.md b/src/packages/sidenavbar/doc.en-US.md index 64af02c249..63556f60ec 100644 --- a/src/packages/sidenavbar/doc.en-US.md +++ b/src/packages/sidenavbar/doc.en-US.md @@ -1,5 +1,7 @@ # SideNavBar组件 +> **⚠️ Note:** This component is deprecated and will be removed in the future. Please use [SideBar](#/en-UScomponent/sidebar) instead. + For content selection and switching ## Import diff --git a/src/packages/sidenavbar/doc.md b/src/packages/sidenavbar/doc.md index 18cdc3d342..9885cfed6a 100644 --- a/src/packages/sidenavbar/doc.md +++ b/src/packages/sidenavbar/doc.md @@ -1,5 +1,7 @@ # SideNavBar组件 +> **⚠️ 注意：** 该组件即将被废弃。请使用 [SideBar](#/zh-CN/component/sidebar) 代替。 + 用于内容选择和切换 ## 引入 diff --git a/src/packages/sidenavbar/doc.taro.md b/src/packages/sidenavbar/doc.taro.md index 1db5ec19e3..f8ec0847b6 100644 --- a/src/packages/sidenavbar/doc.taro.md +++ b/src/packages/sidenavbar/doc.taro.md @@ -1,6 +1,7 @@ # SideNavBar组件 -用于内容选择和切换 +> **⚠️ 注意：** 该组件即将被废弃。请使用 [SideBar](#/zh-CN/component/sidebar) 代替。 +> 用于内容选择和切换 ## 引入 diff --git a/src/packages/sidenavbar/doc.zh-TW.md b/src/packages/sidenavbar/doc.zh-TW.md index d100e8ba5b..6cdbfbe98e 100644 --- a/src/packages/sidenavbar/doc.zh-TW.md +++ b/src/packages/sidenavbar/doc.zh-TW.md @@ -1,5 +1,7 @@ # SideNavBar組件 +> **⚠️ 注意：** 該組件即將被廢棄。請使用 [SideBar](#/zh-CN/component/sidebar) 代替。 + 用於內容選擇和切換 ## 引入 diff --git a/src/packages/sidenavbar/sidenavbar.taro.tsx b/src/packages/sidenavbar/sidenavbar.taro.tsx index c2c89928bb..64cc360761 100644 --- a/src/packages/sidenavbar/sidenavbar.taro.tsx +++ b/src/packages/sidenavbar/sidenavbar.taro.tsx @@ -1,10 +1,12 @@ -import React, { FunctionComponent, useState, ReactNode } from 'react' +import React, { FunctionComponent, useState, ReactNode, useEffect } from 'react' import classNames from 'classnames' import { View } from '@tarojs/components' import Popup from '@/packages/popup/index.taro' import { OffsetContext } from './context' import { BasicComponent, ComponentDefaults } from '@/utils/typings' - +/** + * @deprecated Use SideBar instead. + */ export interface SideNavBarProps extends Omit, 'title'>, BasicComponent { @@ -24,6 +26,11 @@ const defaultProps = { export const SideNavBar: FunctionComponent> = ( props ) => { + useEffect(() => { + console.warn( + 'Warning: SideNavBar is deprecated and will be removed in future versions. Please use NewComponent SideBar instead.' + ) + }, []) const classPrefix = 'nut-sidenavbar' const { title, diff --git a/src/packages/sidenavbar/sidenavbar.tsx b/src/packages/sidenavbar/sidenavbar.tsx index c1cd4267c2..724a298128 100644 --- a/src/packages/sidenavbar/sidenavbar.tsx +++ b/src/packages/sidenavbar/sidenavbar.tsx @@ -1,10 +1,12 @@ -import React, { FunctionComponent, ReactNode } from 'react' +import React, { FunctionComponent, ReactNode, useEffect } from 'react' import classNames from 'classnames' import Popup from '@/packages/popup' import { handleClick } from './utils' import { OffsetContext } from './context' import { BasicComponent, ComponentDefaults } from '@/utils/typings' - +/** + * @deprecated Use SideBar instead. + */ export interface SideNavBarProps extends Omit, 'title'>, BasicComponent { @@ -25,6 +27,11 @@ const defaultProps = { export const SideNavBar: FunctionComponent> = ( props ) => { + useEffect(() => { + console.warn( + 'Warning: SideNavBar is deprecated and will be removed in future versions. Please use NewComponent SideBar instead.' + ) + }, []) const classPrefix = 'nut-sidenavbar' const { title, From 207b8de65c505dad92df2b082b290ecb9b79b4e4 Mon Sep 17 00:00:00 2001 From: "Alex.hxy" <1872591453@qq.com> Date: Fri, 27 Dec 2024 18:38:24 +0800 Subject: [PATCH 2/2] chore: deprecated component help --- src/packages/sidenavbar/doc.en-US.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/packages/sidenavbar/doc.en-US.md b/src/packages/sidenavbar/doc.en-US.md index 63556f60ec..be9425738c 100644 --- a/src/packages/sidenavbar/doc.en-US.md +++ b/src/packages/sidenavbar/doc.en-US.md @@ -1,6 +1,6 @@ # SideNavBar组件 -> **⚠️ Note:** This component is deprecated and will be removed in the future. Please use [SideBar](#/en-UScomponent/sidebar) instead. +> **⚠️ Note:** This component is deprecated and will be removed in the future. Please use [SideBar](#/en-US/component/sidebar) instead. For content selection and switching