@fle-ui/next 1.0.0-alpha.1 → 1.0.0-alpha.2

package/components/notification/demos/custom-style.tsx

@@ -1,29 +0,0 @@
-/**
- * title: 自定义样式
- * desc: 使用 style 和 className 来定义样式。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-
-const Demo = () => {
-  const openNotification = () => {
-    notification.open({
-      message: 'Notification Title',
-      description:
-        'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
-      className: 'custom-class',
-      style: {
-        width: 600,
-      },
-    });
-  };
-
-  return (
-    <Button type="primary" onClick={openNotification}>
-      Open the notification box
-    </Button>
-  );
-};
-
-export default Demo;

package/components/notification/demos/duration.tsx

@@ -1,27 +0,0 @@
-/**
- * title: 自动关闭的延时
- * desc: 自定义通知框自动关闭的延时，默认 4.5s，取消自动关闭只要将该值设为 0 即可。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-
-const Demo = () => {
-  const openNotification = () => {
-    const args = {
-      message: 'Notification Title',
-      description:
-        'I will never close automatically. This is a purposely very very long description that has many many characters and words.',
-      duration: 0,
-    };
-    notification.open(args);
-  };
-
-  return (
-    <Button type="primary" onClick={openNotification}>
-      Open the notification box
-    </Button>
-  );
-};
-
-export default Demo;

package/components/notification/demos/hooks.tsx

@@ -1,61 +0,0 @@
-/**
- * title: 通过 Hooks 获取上下文
- * desc: 通过 `notification.useNotification` 创建支持读取 context 的 `contextHolder`。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-import { Divider, Space } from 'antd';
-import {
-  RadiusUpleftOutlined,
-  RadiusUprightOutlined,
-  RadiusBottomleftOutlined,
-  RadiusBottomrightOutlined,
-} from '@ant-design/icons';
-
-const Context = React.createContext({ name: 'Default' });
-
-const Demo = () => {
-  const [api, contextHolder] = notification.useNotification();
-
-  const openNotification = (
-    placement: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight',
-  ) => {
-    api.info({
-      message: `Notification ${placement}`,
-      description: (
-        <Context.Consumer>{({ name }) => `Hello, ${name}!`}</Context.Consumer>
-      ),
-      placement,
-    });
-  };
-
-  return (
-    <Context.Provider value={{ name: 'Ant Design' }}>
-      {contextHolder}
-      <Space>
-        <Button type="primary" onClick={() => openNotification('topLeft')}>
-          <RadiusUpleftOutlined />
-          topLeft
-        </Button>
-        <Button type="primary" onClick={() => openNotification('topRight')}>
-          <RadiusUprightOutlined />
-          topRight
-        </Button>
-      </Space>
-      <Divider />
-      <Space>
-        <Button type="primary" onClick={() => openNotification('bottomLeft')}>
-          <RadiusBottomleftOutlined />
-          bottomLeft
-        </Button>
-        <Button type="primary" onClick={() => openNotification('bottomRight')}>
-          <RadiusBottomrightOutlined />
-          bottomRight
-        </Button>
-      </Space>
-    </Context.Provider>
-  );
-};
-
-export default Demo;

package/components/notification/demos/placement.tsx

@@ -1,55 +0,0 @@
-/**
- * title: 位置
- * desc: 通知从右上角、右下角、左下角、左上角弹出。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-import { Divider, Space } from 'antd';
-import {
-  RadiusUpleftOutlined,
-  RadiusUprightOutlined,
-  RadiusBottomleftOutlined,
-  RadiusBottomrightOutlined,
-} from '@ant-design/icons';
-
-const Demo = () => {
-  const openNotification = (
-    placement: 'topLeft' | 'topRight' | 'bottomLeft' | 'bottomRight',
-  ) => {
-    notification.info({
-      message: `Notification ${placement}`,
-      description:
-        'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
-      placement,
-    });
-  };
-
-  return (
-    <>
-      <Space>
-        <Button type="primary" onClick={() => openNotification('topLeft')}>
-          <RadiusUpleftOutlined />
-          topLeft
-        </Button>
-        <Button type="primary" onClick={() => openNotification('topRight')}>
-          <RadiusUprightOutlined />
-          topRight
-        </Button>
-      </Space>
-      <Divider />
-      <Space>
-        <Button type="primary" onClick={() => openNotification('bottomLeft')}>
-          <RadiusBottomleftOutlined />
-          bottomLeft
-        </Button>
-        <Button type="primary" onClick={() => openNotification('bottomRight')}>
-          <RadiusBottomrightOutlined />
-          bottomRight
-        </Button>
-      </Space>
-    </>
-  );
-};
-
-export default Demo;

package/components/notification/demos/update.tsx

@@ -1,33 +0,0 @@
-/**
- * title: 更新消息内容
- * desc: 可以通过唯一的 key 来更新内容。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-
-const Demo = () => {
-  const key = 'updatable';
-
-  const openNotification = () => {
-    notification.open({
-      key,
-      message: 'Notification Title',
-      description: 'description.',
-    });
-    setTimeout(() => {
-      notification.open({
-        key,
-        message: 'New Title',
-        description: 'New description.',
-      });
-    }, 1000);
-  };
-  return (
-    <Button type="primary" onClick={openNotification}>
-      Open the notification box
-    </Button>
-  );
-};
-
-export default Demo;

package/components/notification/demos/with-btn.tsx

@@ -1,44 +0,0 @@
-/**
- * title: 自定义按钮
- * desc: 自定义关闭按钮的样式和文字。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-
-const Demo = () => {
-  const close = () => {
-    console.log(
-      'Notification was closed. Either the close button was clicked or duration time elapsed.',
-    );
-  };
-
-  const openNotification = () => {
-    const key = `open${Date.now()}`;
-    const btn = (
-      <Button
-        type="primary"
-        size="small"
-        onClick={() => notification.close(key)}
-      >
-        Confirm
-      </Button>
-    );
-    notification.open({
-      message: 'Notification Title',
-      description:
-        'A function will be be called after the notification is closed (automatically after the "duration" time of manually).',
-      btn,
-      key,
-      onClose: close,
-    });
-  };
-
-  return (
-    <Button type="primary" onClick={openNotification}>
-      Open the notification box
-    </Button>
-  );
-};
-
-export default Demo;

package/components/notification/demos/with-icon.tsx

@@ -1,35 +0,0 @@
-/**
- * title: 带有图标的通知提醒框
- * desc: 通知提醒框左侧有图标。
- */
-
-import React from 'react';
-import { Button, notification } from '@fle-ui/next';
-import { Space } from 'antd';
-
-const Demo = () => {
-  const openNotificationWithIcon = (
-    type: 'success' | 'info' | 'warning' | 'error',
-  ) => {
-    notification[type]({
-      message: 'Notification Title',
-      description:
-        'This is the content of the notification. This is the content of the notification. This is the content of the notification.',
-    });
-  };
-
-  return (
-    <Space>
-      <Button onClick={() => openNotificationWithIcon('success')}>
-        Success
-      </Button>
-      <Button onClick={() => openNotificationWithIcon('info')}>Info</Button>
-      <Button onClick={() => openNotificationWithIcon('warning')}>
-        Warning
-      </Button>
-      <Button onClick={() => openNotificationWithIcon('error')}>Error</Button>
-    </Space>
-  );
-};
-
-export default Demo;

package/components/notification/index.tsx

@@ -1,10 +0,0 @@
-import { notification } from 'antd';
-import {
-  NotificationApi,
-  NotificationPlacement,
-  NotificationInstance,
-} from 'antd/es/notification';
-
-export type { NotificationApi, NotificationPlacement, NotificationInstance };
-
-export default notification;

package/components/notification/notification.md

@@ -1,140 +0,0 @@
----
-title: Notification 反馈
-order: 0
-legacy: /notification
-group:
-  path: /
-nav:
-  title: 组件
-  path: /components
----
-
-# Notification 反馈
-
-全局展示通知提醒信息。
-
-## 何时使用
-
-在系统四个角显示通知提醒信息。经常用于以下情况：
-
-- 较为复杂的通知内容。
-- 带有交互的通知，给出用户下一步的行动点。
-- 系统主动推送。
-
-## 代码演示
-
-### 基本使用
-<code src="./demos/basic.tsx" />
-
-### 自动关闭的延时
-<code src="./demos/duration.tsx" />
-
-### 带有图标的通知提醒框
-<code src="./demos/with-icon.tsx" />
-
-### 自定义按钮
-<code src="./demos/with-btn.tsx" />
-
-### 自定义样式
-<code src="./demos/custom-style.tsx" />
-
-### 自定义图标
-<code src="./demos/custom-icon.tsx" />
-
-### 位置
-<code src="./demos/placement.tsx" />
-
-### 通过 Hooks 获取上下文
-<code src="./demos/hooks.tsx" />  
-
-### 更新消息内容
-<code src="./demos/update.tsx" />  
-
-
-## API
-
-- `notification.success(config)`
-- `notification.error(config)`
-- `notification.info(config)`
-- `notification.warning(config)`
-- `notification.warn(config)`
-- `notification.open(config)`
-- `notification.close(key: String)`
-- `notification.destroy()`
-
-config 参数如下：
-
-| 参数 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 |
-| btn | 自定义关闭按钮 | ReactNode | - |
-| className | 自定义 CSS class | string | - |
-| closeIcon | 自定义关闭图标 | ReactNode | - |
-| description | 通知提醒内容，必选 | ReactNode | - |
-| duration | 默认 4.5 秒后自动关闭，配置为 null 则不自动关闭 | number | 4.5 |
-| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body |
-| icon | 自定义图标 | ReactNode | - |
-| key | 当前通知唯一标志 | string | - |
-| message | 通知提醒标题，必选 | ReactNode | - |
-| placement | 弹出位置，可选 `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
-| style | 自定义内联样式 | [CSSProperties](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/e434515761b36830c3e58a970abf5186f005adac/types/react/index.d.ts#L794) | - |
-| top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 |
-| onClick | 点击通知时触发的回调函数 | function | - |
-| onClose | 当通知关闭时触发 | function | - |
-
-还提供了一个全局配置方法，在调用前提前配置，全局一次生效。
-
-- `notification.config(options)`
-
-  > 当你使用 `ConfigProvider` 进行全局化配置时，系统会默认自动开启 RTL 模式。(4.3.0+)
-  >
-  > 当你想单独使用，可通过如下设置开启 RTL 模式。
-
-
-```bash
-  notification.config({
-    placement: 'bottomRight',
-    bottom: 50,
-    duration: 3,
-    rtl: true,
-  });
-```
-
-| 参数 | 说明 | 类型 | 默认值 |
-| --- | --- | --- | --- |
-| bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 |
-| closeIcon | 自定义关闭图标 | ReactNode | - |
-| duration | 默认自动关闭延时，单位秒 | number | 4.5 |
-| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body |
-| placement | 弹出位置，可选 `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` |
-| rtl | 是否开启 RTL 模式 | boolean | false |
-| top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 |
-
-
-## FAQ
-
-### 为什么 notification 不能获取 context、redux 的内容和 ConfigProvider 的 `locale/prefixCls` 配置？
-
-直接调用 notification 方法，antd 会通过 `ReactDOM.render` 动态创建新的 React 实体。其 context 与当前代码所在 context 并不相同，因而无法获取 context 信息。
-
-当你需要 context 信息（例如 ConfigProvider 配置的内容）时，可以通过 `notification.useNotification` 方法会返回 `api` 实体以及 `contextHolder` 节点。将其插入到你需要获取 context 位置即可：
-
-```bash
-const [api, contextHolder] = notification.useNotification();
-
-return (
-  <Context1.Provider value="Ant">
-    {/* contextHolder 在 Context1 内，它可以获得 Context1 的 context */}
-    {contextHolder}
-    <Context2.Provider value="Design">
-      {/* contextHolder 在 Context2 外，因而不会获得 Context2 的 context */}
-    </Context2.Provider>
-  </Context1.Provider>
-);
-```
-
-**异同：**通过 hooks 创建的 `contextHolder` 必须插入到子元素节点中才会生效，当你不需要上下文信息时请直接调用。
-
-### 静态方法如何设置 prefixCls ？
-
-你可以通过 [`ConfigProvider.config`](/components/config-provider/#ConfigProvider.config()-4.13.0+) 进行设置。