@modern-js/main-doc 2.0.0-beta.0 → 2.0.0-beta.1

package/zh/apis/app/runtime/utility/loadable/loadable-library.md

@@ -1,67 +0,0 @@
----
-title: LoadableLibrary
-sidebar_position: 4
----
-
-`lazy.lib` 和 `loadable.lib` 函数返回 `LoadableLibrary` 对象
-
-## LoadableLibrary 类型
-
-```ts
-type LoadableLibrary = React.ComponentType<{
-  fallback?: JSX.Element;
-  children?: (module: Module) => React.ReactNode;
-  ref?: React.Ref<Module>;
-}>
-```
-
-### fallback
-
-类型：`JSX.Element`
-
-组件 `loading` 阶段显示 `fallback` 内容。
-
-### children
-
-库加载完成只有的回调。
-
-```ts
-import loadable from '@modern-js/runtime/loadable'
-const Moment = loadable.lib(() => import('moment'))
-function FromNow({ date }) {
-  return (
-    <div>
-      <Moment fallback={date.toLocaleDateString()}>
-        {({ default: moment }) => moment(date).fromNow()}
-      </Moment>
-    </div>
-  )
-}
-```
-
-### ref
-
-类型：`React.Ref<Module>`
-
-可以通过 `ref` 拿到所加载库的实例。
-
-```ts
-import loadable from '@modern-js/runtime/loadable'
-const Moment = loadable.lib(() => import('moment'))
-class MyComponent {
-  moment = React.createRef()
-  handleClick = () => {
-    if (this.moment.current) {
-      return alert(this.moment.current.default.format('HH:mm'))
-    }
-  }
-  render() {
-    return (
-      <div>
-        <button onClick={this.handleClick}>What time is it?</button>
-        <Moment ref={this.moment} />
-      </div>
-    )
-  }
-}
-```

package/zh/apis/generator/plugin/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "生成器插件 API",
-  "position": 2
-}

package/zh/apis/generator/plugin/input/addOptionAfter.md

@@ -1,45 +0,0 @@
----
-sidebar_position: 6
----
-
-# addOptionAfter
-
-在特定问题的默认选项后 Options 选项。
-
-该方法可直接在 context 上获取。
-
-其类型定义为:
-
-```ts
-export interface IPluginContext {
-  addOptionAfter: (key: string, optionKey: string, option: IOption) => void;
-  ...
-}
-```
-
-## key
-
-问题关键字。
-Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
-
-## optionKey
-
-问题选项关键字。
-Modern.js 工程方案的配置的问题选项关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
-
-## options
-
-需要添加的选项，具体类型定义可查看[自定义输入相关类型定义](/docs/apis/generator/plugin/input/type)。
-
-## 示例
-
-```ts
-context.addOptionAfter('packageManager', 'pnpm', {
-    key: "npm",
-    name: "NPM"
-});
-```
-
-:::info
-对于 Modern.js 工程类型提供的输入选项，暂时只支持删除，不支持增加，增加会造成代码中的逻辑判断存在问题。上方示例不可直接使用。
-:::

package/zh/apis/generator/plugin/input/addOptionBefore.md

@@ -1,45 +0,0 @@
----
-sidebar_position: 5
----
-
-# addOptionBefore
-
-在特定问题的默认选项前 Options 选项。
-
-该方法可直接在 context 上获取。
-
-其类型定义为:
-
-```ts
-export interface IPluginContext {
-    addOptionBefore: (key: string, optionKey: string, option: IOption) => void;
-  ...
-}
-```
-
-## key
-
-问题关键字。
-Modern.js 工程方案的配置的问题关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
-
-## optionKey
-
-问题选项关键字。
-Modern.js 工程方案的配置的问题选项关键字，具体配置可查看[生成器配置](/docs/configure/generator/introduce)。
-
-## options
-
-需要添加的选项，具体类型定义可查看[自定义输入相关类型定义](/docs/apis/generator/plugin/input/type)。
-
-## 示例
-
-```ts
-context.addOptionBefore('packageManager', 'pnpm', {
-    key: "npm",
-    name: "NPM"
-});
-```
-
-:::info
-对于 Modern.js 工程类型提供的输入选项，暂时只支持删除，不支持增加，增加会造成代码中的逻辑判断存在问题。上方示例不可直接使用。
-:::

package/zh/apis/generator/plugin/input/type.md

@@ -1,101 +0,0 @@
----
-sidebar_position: 1
----
-
-# 自定义输入相关类型定义
-
-## Input
-
-输入类型结构，其类型定义为：
-
-```ts
-interface Input {
-    key: string;
-    name: string;
-    type: 'input' | 'radio' | 'checkbox';
-    options?: IOption[];
-    validate?: (value: any, data: Record<string, unknown>, extra?: Record<string, unknown>) => {
-        success: boolean;
-        error?: string;
-    } | Promise<{
-        success: boolean;
-        error?: string;
-    >
-    when?: (input: Record<string, any>, extra?: Record<string, any>) => Promise<boolean>
-}
-```
-
-### key
-
-关键字，作为输入字段的 key，可在生成器插件生命周期中通过 `input[key]` 获取到用户输入。
-
-### name
-
-展示名称。
-
-### type
-
-输入类型，包含三种值:
-
-- input：直接输入类型。
-
-- radio：单选类型，需配合 options 使用。
-
-- checkbox：多选类型，需配合 options 使用。
-
-### options
-
-单选和多选类型时选项，选项结构后续介绍。
-
-### validate
-
-验证函数，当用户输入之后，可在该函数中对输入进行验证。其中：
-
-- value 为当前输入字段值
-
-- data 为当前表单的所有输入字段值
-
-- extra 为从 config 参数额外传入的参数
-
-### when
-
-条件函数，用于控制问题是否展示，当该函数返回 true 时，问题展示。其中:
-
-- input 为当前表单的所有输入字段值
-
-- extra 为从 config 参数额外传入的参数
-
-## Option
-
-option 为输入选项，当自定义 Input 类型为 `radio` 或 `checkbox` 时，需要该配置。
-
-option 类型定义为：
-
-```ts
-interface IOption {
-    key: string;
-    name: string;
-    isDefault?: boolean; // 是否为默认值，存在多个，以第一个选项为主，当前默认选项正好不展示，将会取第一个展示的选项值
-    when?: (input: Record<string, any>, extra?: Record<string, any>) => Promise<boolean> // 问题可根据之前输入决定是否展示
-}
-```
-
-### key
-
-关键字，option 选项的关键字，当选中该选项是，对应 `input` 的值为该字段值。
-
-### name
-
-展示名称。
-
-### isDefault
-
-是否为默认值，设置为 true 时，展示问题会默认选择该选项
-
-### when
-
-条件函数，用于控制选项是否展示，当该函数返回 true 时，问题展示。其中:
-
-- input 为当前表单的所有输入字段值
-
-- extra 为从 config 参数额外传入的参数

package/zh/guides/topic-detail/generator-plugin/_category_.json

@@ -1,4 +0,0 @@
-{
-  "label": "自定义生成器插件",
-  "position": 7
-}