docs: 组件文档中显示出 disabledPortal 和 container api (#2924)

* docs: 组件文档中显示出 disabledPortal 和 container api * chore: 去掉示例调试代码
XiaoMi · Jul 3, 2024 · a227f4b · a227f4b
1 parent 3621112
commit a227f4b
Show file tree

Hide file tree

Showing 6 changed files with 14 additions and 10 deletions.
diff --git a/.changeset/giant-mirrors-repair.md b/.changeset/giant-mirrors-repair.md
@@ -0,0 +1,5 @@
+---
+"@hi-ui/preview": patch
+---
+
+chore: 添加 @hi-ui/watermark 依赖
diff --git a/packages/ui/drawer/src/Drawer.tsx b/packages/ui/drawer/src/Drawer.tsx
@@ -210,8 +210,7 @@ export interface DrawerProps extends Omit<HiBaseHTMLProps<'div'>, 'title'>, UseM
    */
   timeout?: number
   /**
-   * 禁用 portal。暂不对外暴露
-   * @private
+   * 禁用 portal
    */
   disabledPortal?: boolean
   /**

diff --git a/packages/ui/modal/src/Modal.tsx b/packages/ui/modal/src/Modal.tsx
@@ -284,8 +284,7 @@ export interface ModalProps extends HiBaseHTMLProps<'div'>, UseModalProps {
    */
   showFooterDivider?: boolean
   /**
-   * 禁用 portal。暂不对外暴露
-   * @private
+   * 禁用 portal
    */
   disabledPortal?: boolean
   /**

diff --git a/packages/ui/number-input/src/NumberInput.tsx b/packages/ui/number-input/src/NumberInput.tsx
@@ -10,7 +10,7 @@ const _prefix = getPrefixCls('number-input')
 /**
  * 数字输入框
  */
-export const NumberInput = forwardRef<HTMLDivElement | null, CounterProps>(
+export const NumberInput = forwardRef<HTMLDivElement | null, NumberInputProps>(
   ({ prefixCls = _prefix, role = _role, prefix, ...rest }, ref) => {
     const { rootProps, getInputProps, getMinusButtonProps, getPlusButtonProps } = useCounter({
       prefixCls,
@@ -35,7 +35,9 @@ export const NumberInput = forwardRef<HTMLDivElement | null, CounterProps>(
   }
 )
 
-export interface NumberInputProps extends CounterProps {}
+export interface NumberInputProps extends CounterProps {
+  prefix?: React.ReactNode
+}
 
 if (__DEV__) {
   NumberInput.displayName = 'NumberInput'

diff --git a/packages/ui/preview/package.json b/packages/ui/preview/package.json
@@ -49,6 +49,7 @@
     "@hi-ui/portal": "^4.0.8",
     "@hi-ui/use-latest": "^4.0.4",
     "@hi-ui/use-uncontrolled-state": "^4.0.4",
+    "@hi-ui/watermark": "^4.0.8",
     "react-transition-group": "^4.4.2"
   },
   "peerDependencies": {

diff --git a/packages/ui/tooltip/src/Tooltip.tsx b/packages/ui/tooltip/src/Tooltip.tsx
@@ -180,13 +180,11 @@ export interface TooltipProps extends HiBaseHTMLProps<'div'>, UseTooltipProps {
    */
   innerRef?: React.Ref<TooltipHelpers>
   /**
-   * 指定 portal 的容器。暂不对外暴露
-   * @private
+   * 指定 portal 的容器
    */
   container?: HTMLElement
   /**
-   * 禁用 portal。暂不对外暴露
-   * @private
+   * 禁用 portal
    */
   disabledPortal?: boolean
 }