有条件的
有条件的Wrap根据布尔条件有条件地将儿童用包装器组件包裹.
安装
npm install @cleartrip/ct-design-conditional-wrap
# or
pnpm add @cleartrip/ct-design-conditional-wrap
同伴依赖关系
# Required for all targets
npm install react
# Web only
npm install react-dom
# React Native only
npm install react-native
使用量
基本有条件的包装
import ConditionalWrap from '@cleartrip/ct-design-conditional-wrap';
function Example({ hasLink }: { hasLink: boolean }) {
return (
<ConditionalWrap
condition={hasLink}
wrap={(children) => <a href="/link">{children}</a>}
>
<span>This may or may not be wrapped in a link</span>
</ConditionalWrap>
);
}
有条件的样式包装
<ConditionalWrap
condition={isHighlighted}
wrap={(children) => (
<div style={{ backgroundColor: 'yellow', padding: 8 }}>
{children}
</div>
)}
>
<div>Content that might be highlighted</div>
</ConditionalWrap>
模块或对话框包装
<ConditionalWrap
condition={showInModal}
wrap={(children) => (
<div className="modal-overlay">
<div className="modal-content">
{children}
</div>
</div>
)}
>
<div>Content that may appear in a modal</div>
</ConditionalWrap>
道具
| Prop | 类型 | 默认 | 需求 | 说明 |
|---|---|---|---|---|
condition | boolean | —— 说 | 对 | 决定是否应用收发夹的布尔条件 |
wrap | (component: ReactElement) => ReactElement | —— 说 | 对 | 当条件属实时将孩子包裹起来的函数 |
children | ReactElement | —— 说 | 对 | 有条件地包装的儿童元素 |
使用大小写
有条件链接
仅在提供 URL 时在链接中环绕文本 :
<ConditionalWrap
condition={!!url}
wrap={(children) => <a href={url}>{children}</a>}
>
<span>{linkText}</span>
</ConditionalWrap>
有条件的工具提示
仅在工具提示文本存在时添加工具提示 :
<ConditionalWrap
condition={!!tooltipText}
wrap={(children) => (
<div title={tooltipText}>
{children}
</div>
)}
>
<button>Action Button</button>
</ConditionalWrap>
有条件的形式包装器
有条件地环绕窗体元素 :
<ConditionalWrap
condition={isDisabled}
wrap={(children) => (
<fieldset disabled>
{children}
</fieldset>
)}
>
<input type="text" />
</ConditionalWrap>
行为
- 何时
condition实值true,则wrap函数调用children作为论据 - 何时
condition实值false, (中文(简体) ),children返回时不变 - 组件是纯函数,没有副作用
- 只接受单个孩子元素( ReactElement)
业绩
- 极轻的部件,但间接费用极少
- 没有状态或影响,纯粹是功能性的
- Wrapper 函数仅在条件属实时调用
- 如果制作费太高,考虑纪念包装功能
移徙
如果从上一版本迁移:
- import { ConditionalWrap } from 'old-package';
+ import ConditionalWrap from '@cleartrip/ct-design-conditional-wrap';