amis/docs/zh-CN/start/getting-started.md

528 lines
13 KiB
Markdown
Raw Normal View History

2020-07-28 14:55:49 +08:00
---
title: 快速开始
description:
---
2020-08-12 16:39:54 +08:00
amis 有两种使用方法:
- [JS SDK](#SDK),可以用在任意页面中
- [React](#react),可以用在 React 项目中
2020-08-12 16:39:54 +08:00
SDK 版本适合对前端或 React 不了解的开发者,它不依赖 npm 及 webpack可以像 Vue/jQuery 那样外链代码就能使用。
2020-08-12 16:39:54 +08:00
2020-09-11 15:00:56 +08:00
## SDK
下载方式:
2020-09-11 15:00:56 +08:00
1. github 的 [releases](https://github.com/baidu/amis/releases),文件是 sdk.tar.gz。
1. 使用 `npm i amis` 来下载,在 `node_modules\amis\sdk` 目录里就能找到。
2020-09-11 15:00:56 +08:00
默认会提供一个 demo.html 作为示例,双击这个文件打开就能看到效果,其中最重要是如下代码:
2020-09-11 15:00:56 +08:00
```html
<!DOCTYPE html>
<html lang="zh">
<head>
<meta charset="UTF-8" />
<title>amis demo</title>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<meta
name="viewport"
content="width=device-width, initial-scale=1, maximum-scale=1"
/>
<meta http-equiv="X-UA-Compatible" content="IE=Edge" />
<link rel="stylesheet" href="sdk.css" />
<!-- 从 1.1.0 开始 sdk.css 将不支持 IE 11如果要支持 IE11 请引用这个 css并把前面那个删了 -->
<!-- <link rel="stylesheet" href="sdk-ie11.css" /> -->
<!-- 不过 amis 开发团队几乎没测试过 IE 11 下的效果,所以可能有细节功能用不了,如果发现请报 issue -->
2020-09-11 15:00:56 +08:00
<style>
html,
body,
.app-wrapper {
position: relative;
width: 100%;
height: 100%;
margin: 0;
padding: 0;
}
</style>
</head>
<body>
<div id="root" class="app-wrapper"></div>
<script src="sdk.js"></script>
2020-09-11 15:00:56 +08:00
<script type="text/javascript">
(function () {
let amis = amisRequire('amis/embed');
// 通过替换下面这个配置来生成不同页面
let amisJSON = {
2020-09-11 15:00:56 +08:00
type: 'page',
title: '表单页面',
body: {
type: 'form',
mode: 'horizontal',
api: '/saveForm',
controls: [
{
label: 'Name',
type: 'text',
name: 'name'
},
{
label: 'Email',
type: 'email',
name: 'email'
}
]
}
};
let amisScoped = amis.embed('#root', amisJSON);
2020-09-11 15:00:56 +08:00
})();
</script>
</body>
</html>
```
### 切换主题
jssdk 版本默认使用 `sdk.css` 即默认主题,如果你想用使用云舍,请改成引用 `cxd.scss`。同时 js 渲染地方第四个参数传入 `theme` 属性。如:
```js
amis.embed(
'#root',
{
// amis schema
},
{
// 这里是初始 props
},
{
theme: 'cxd'
}
);
```
暗黑主题同理,改成引用 'dark.css' 同时主题设置成 `dark`
2020-09-11 15:00:56 +08:00
### 控制 amis 的行为
`amis.embed` 函数还支持以下配置项来控制 amis 的行为,比如在 fetcher 的时候加入自己的处理逻辑,这些函数参数的说明在后面 React 中也有介绍。
2020-09-11 15:00:56 +08:00
```js
let amisScoped = amis.embed(
'#root',
amisJSON,
2020-09-11 15:00:56 +08:00
{
// 这里是初始 props一般不用传。
// locale: 'en-US' // props 中可以设置语言,默认是中文
2020-09-11 15:00:56 +08:00
},
{
// 可以不传,用来实现 ajax 请求
fetcher: (url, method, data, config) => {},
// 可以不传,全局 api 适配器。
// 另外在 amis 配置项中的 api 也可以配置适配器,针对某个特定接口单独处理。
2020-10-23 11:25:29 +08:00
responseAdpater(api, response, query, request) {
return response;
}
2020-09-11 15:00:56 +08:00
// 可以不传,用来接管页面跳转,比如用 location.href 或 window.open或者自己实现 amis 配置更新
// jumpTo: to => { location.href = to; },
2020-09-11 15:00:56 +08:00
// 可以不传,用来实现地址栏更新
// updateLocation: (to, replace) => {},
2020-09-11 15:00:56 +08:00
// 可以不传,用来判断是否目标地址当前地址。
// isCurrentUrl: url => {},
2020-09-11 15:00:56 +08:00
// 可以不传,用来实现复制到剪切板
// copy: content => {},
2020-09-11 15:00:56 +08:00
// 可以不传,用来实现通知
// notify: (type, msg) => {},
2020-09-11 15:00:56 +08:00
// 可以不传,用来实现提示
// alert: content => {},
2020-09-11 15:00:56 +08:00
// 可以不传,用来实现确认框。
// confirm: content => {},
// theme: 'cxd' // 主题,默认是 default还可以设置成 cxd 或 dark但记得引用它们的 css比如 sdk 目录下的 cxd.css
2020-09-11 15:00:56 +08:00
}
);
```
同时返回的 `amisScoped` 对象可以获取到 amis 渲染的内部信息,它有如下方法:
`getComponentByName(name)` 用于获取渲染出来的组件,比如下面的示例
```json
{
"type": "page",
"name": "page1",
"title": "表单页面",
"body": {
"type": "form",
"name": "form1",
"controls": [
{
"label": "Name",
"type": "text",
"name": "name1"
}
]
}
}
```
可以通过 `amisScoped.getComponentByName('page1.form1').getValues()` 来获取到所有表单的值,需要注意 page 和 form 都需要有 name 属性。
2020-11-12 16:57:45 +08:00
还可以通过 `amisScoped.getComponentByName('page1.form1').setValues({'name1': 'othername'})` 来修改表单中的值。
## react
2020-07-28 14:55:49 +08:00
2020-11-20 10:21:20 +08:00
初始项目请参考 <https://github.com/fex-team/amis-react-starter>
如果在已有项目中React 版本需要是 `^16.8.6`mobx 需要 `^4.5.0`
2020-07-28 14:55:49 +08:00
### 安装
```
npm i amis
```
2020-08-04 10:55:22 +08:00
### 主题样式
目前支持三种主题:`default默认主题`、`cxd云舍`和`dark暗黑`
1. 引入样式文件:
2020-08-04 13:16:20 +08:00
html 中引入:
2020-08-04 10:55:22 +08:00
```html
<link href="./node_modules/amis/lib/themes/default.css" />
<!-- 或 <link href="./node_modules/amis/lib/themes/cxd.css" /> -->
<!-- 或 <link href="./node_modules/amis/lib/themes/dark.css" /> -->
```
js 中引入:
```js
import './node_modules/amis/lib/themes/default.css';
// 或 import './node_modules/amis/lib/themes/cxd.css';
// 或 import './node_modules/amis/lib/themes/dark.css';
```
> 上面只是示例,请根据自己的项目结构调整引用路径
2. 渲染器使用配置主题
```js
renderAmis(
{
type: 'page',
title: '简单页面',
body: '内容'
},
{
// props
},
2020-08-04 10:55:22 +08:00
{
// env...
2020-08-04 13:16:20 +08:00
theme: 'default' // cxd 或 dark
2020-08-04 10:55:22 +08:00
}
);
```
2020-08-18 18:53:18 +08:00
### 使用指南
2020-07-28 14:55:49 +08:00
可以在 React Component 这么使用TypeScript
2020-08-18 18:53:18 +08:00
1. 安装部分示例需要的插件库
```
npm i axios copy-to-clipboard
```
> 为了方便示例,上面选用了我们常用几个插件库,你完全可以选择自己喜欢的插件并重新实现
2020-09-11 12:58:20 +08:00
2. 代码实现React Typescript
2020-08-18 18:53:18 +08:00
2020-07-28 14:55:49 +08:00
```tsx
import * as React from 'react';
2020-08-18 18:53:18 +08:00
import axios from 'axios';
import copy from 'copy-to-clipboard';
import {render as renderAmis, ToastComponent, AlertComponent} from 'amis';
2020-08-18 18:53:18 +08:00
import {alert, confirm} from 'amis/lib/components/Alert';
import {toast} from 'amis/lib/components/Toast';
2020-07-28 14:55:49 +08:00
class MyComponent extends React.Component<any, any> {
2020-08-04 10:55:22 +08:00
render() {
return (
<div>
<p>通过 amis 渲染页面</p>
<ToastComponent key="toast" position={'top-right'} />
<AlertComponent key="alert" />
2020-08-04 10:55:22 +08:00
{renderAmis(
{
// 这里是 amis 的 Json 配置。
type: 'page',
title: '简单页面',
body: '内容'
},
{
2020-08-18 18:53:18 +08:00
// props...
// locale: 'en-US' // 请参考「多语言」的文档
2020-08-04 10:55:22 +08:00
},
{
// 下面三个接口必须实现
2020-08-04 10:55:22 +08:00
fetcher: ({
2020-08-18 18:53:18 +08:00
url, // 接口地址
method, // 请求方法 get、post、put、delete
data, // 请求数据
responseType,
config, // 其他配置
headers // 请求头
}: any) => {
config = config || {};
config.withCredentials = true;
responseType && (config.responseType = responseType);
if (config.cancelExecutor) {
config.cancelToken = new (axios as any).CancelToken(
config.cancelExecutor
);
}
config.headers = headers || {};
if (method !== 'post' && method !== 'put' && method !== 'patch') {
if (data) {
config.params = data;
}
return (axios as any)[method](url, config);
} else if (data && data instanceof FormData) {
config.headers = config.headers || {};
config.headers['Content-Type'] = 'multipart/form-data';
} else if (
data &&
typeof data !== 'string' &&
!(data instanceof Blob) &&
!(data instanceof ArrayBuffer)
) {
data = JSON.stringify(data);
config.headers = config.headers || {};
config.headers['Content-Type'] = 'application/json';
}
return (axios as any)[method](url, data, config);
2020-08-04 10:55:22 +08:00
},
2020-08-18 18:53:18 +08:00
isCancel: (value: any) => (axios as any).isCancel(value),
copy: content => {
copy(content);
toast.success('内容已复制到粘贴板');
2020-08-04 10:55:22 +08:00
}
// 后面这些接口可以不用实现
// 默认是地址跳转
// jumpTo: (
// location: string /*目标地址*/,
// action: any /* action对象*/
// ) => {
// // 用来实现页面跳转, actionType:link、url 都会进来。
// },
// updateLocation: (
// location: string /*目标地址*/,
// replace: boolean /*是replace还是push*/
// ) => {
// // 地址替换,跟 jumpTo 类似
// },
// isCurrentUrl: (
// url: string /*url地址*/,
// ) => {
// // 用来判断是否目标地址当前地址
// },
// notify: (
// type: 'error' | 'success' /**/,
// msg: string /*提示内容*/
// ) => {
// toast[type]
// ? toast[type](msg, type === 'error' ? '系统错误' : '系统消息')
// : console.warn('[Notify]', type, msg);
// },
// alert,
// confirm,
2020-08-04 10:55:22 +08:00
}
)}
</div>
);
}
2020-07-28 14:55:49 +08:00
}
```
2020-08-18 18:53:18 +08:00
### render 函数介绍
```js
(schema, props, env) => JSX.Element;
```
#### schema
即页面配置,请前往 [配置与组件](../concepts/schema) 了解
#### props
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
一般都用不上,如果你想传递一些数据给渲染器内部使用,可以传递 data 数据进去。如:
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
```jsx
() =>
renderAmis(schema, {
data: {
username: 'amis'
}
});
```
这样,内部所有组件都能拿到 `username` 这个变量的值。当然,这里的 key 并不一定必须是 data , 你也可以是其它 key但必须配合 schema 中的 `detectField` 属性一起使用。 如:
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
```jsx
() =>
renderAmis(
{
//其它配置
detectField: 'somekey'
},
{
somekey: {
2020-07-28 14:55:49 +08:00
username: 'amis'
}
2020-08-18 18:53:18 +08:00
}
);
```
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
#### env
2020-08-12 16:39:54 +08:00
2020-08-18 18:53:18 +08:00
环境变量,可以理解为这个渲染器工具的配置项,需要使用 amis 用户实现部分接口。他有下面若干参数:
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
##### fetcher必须实现
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
接口请求器,实现该函数才可以实现 ajax 发送,函数签名如下:
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
```ts
(config: {
url; // 接口地址
method; // 请求方法 get、post、put、delete
data; // 请求数据
responseType;
config; // 其他配置
headers; // 请求头
}) => Promise<fetcherResult>;
```
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
> 你可以使用任何你喜欢的 ajax 请求库来实现这个接口
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
##### notify
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
```ts
(type: string, msg: string) => void
```
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
用来实现消息提示。
2020-07-28 14:55:49 +08:00
2020-08-18 18:53:18 +08:00
##### alert
```ts
(msg: string) => void
```
用来实现警告提示。
##### confirm
```ts
(msg: string) => boolean | Promise<boolean>
```
用来实现确认框。返回 boolean 值
##### jumpTo
```ts
(to: string, action?: Action, ctx?: object) => void
```
用来实现页面跳转,因为不清楚所在环境中是否使用了 spa 模式,所以用户自己实现吧。
##### updateLocation
```ts
(location: any, replace?: boolean) => void
```
地址替换,跟 jumpTo 类似。
##### blockRouting
设置阻止路由跳转的钩子函数,用来实现 form 未保存提前离开时出现确认框。
```ts
(fn: (nextLocation:any) => void | string) => () => void;
```
2020-08-18 18:53:18 +08:00
##### theme: string
目前支持是三种主题:`default`、`cxd` 和 `dark`
##### isCurrentUrl
```ts
(link: string) => boolean;
```
判断目标地址是否为当前页面。
##### copy
```ts
(contents: string, options?: {shutup: boolean})
```
用来实现内容复制。
##### session
默认为 'global',决定 store 是否为全局共用的,如果想单占一个 store请设置不同的值。
##### getModalContainer
```ts
() => HTMLElement;
```
用来决定弹框容器。
##### loadRenderer
```ts
(schema: any, path: string) => Promise<Function>
```
可以通过它懒加载自定义组件,比如: https://github.com/baidu/amis/blob/master/__tests__/factory.test.tsx#L64-L91。
##### affixOffsetTop: number
固顶间距,当你的有其他固顶元素时,需要设置一定的偏移量,否则会重叠。
##### affixOffsetBottom: number
固底间距,当你的有其他固底元素时,需要设置一定的偏移量,否则会重叠。
##### richTextToken: string
2020-09-17 21:40:59 +08:00
内置 rich-text 为 frolaEditor想要使用请自行购买或者用免费的 Tinymce不设置 token 默认就是 Tinymce。