mirror of
https://gitee.com/baidu/amis.git
synced 2024-11-30 02:48:55 +08:00
补充样式文件文档
This commit is contained in:
parent
1425e24339
commit
96b8bdc4f2
@ -11,68 +11,116 @@ description:
|
||||
npm i amis
|
||||
```
|
||||
|
||||
### 主题样式
|
||||
|
||||
目前支持三种主题:`default(默认主题)`、`cxd(云舍)`和`dark(暗黑)`
|
||||
|
||||
1. 引入样式文件:
|
||||
|
||||
```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: '内容'
|
||||
},
|
||||
{
|
||||
theme: 'default' // cxd 或 dark
|
||||
},
|
||||
{
|
||||
// env...
|
||||
}
|
||||
);
|
||||
```
|
||||
|
||||
### 使用
|
||||
|
||||
可以在 React Component 这么使用(TypeScript)。
|
||||
|
||||
```tsx
|
||||
import * as React from 'react';
|
||||
import {
|
||||
render as renderAmis
|
||||
} from 'amis';
|
||||
import {render as renderAmis} from 'amis';
|
||||
|
||||
class MyComponent extends React.Component<any, any> {
|
||||
render() {
|
||||
return (
|
||||
<div>
|
||||
<p>通过 amis 渲染页面</p>
|
||||
{renderAmis({
|
||||
// schema
|
||||
// 这里是 amis 的 Json 配置。
|
||||
type: 'page',
|
||||
title: '简单页面',
|
||||
body: '内容'
|
||||
}, {
|
||||
// props
|
||||
}, {
|
||||
// env
|
||||
// 这些是 amis 需要的一些接口实现
|
||||
// 可以参考本项目里面的 Demo 部分代码。
|
||||
render() {
|
||||
return (
|
||||
<div>
|
||||
<p>通过 amis 渲染页面</p>
|
||||
{renderAmis(
|
||||
{
|
||||
// schema
|
||||
// 这里是 amis 的 Json 配置。
|
||||
type: 'page',
|
||||
title: '简单页面',
|
||||
body: '内容'
|
||||
},
|
||||
{
|
||||
// props
|
||||
},
|
||||
{
|
||||
// env
|
||||
// 这些是 amis 需要的一些接口实现
|
||||
// 可以参考后面的参数介绍。
|
||||
|
||||
updateLocation: (location:string/*目标地址*/, replace:boolean/*是replace,还是push?*/) => {
|
||||
// 用来更新地址栏
|
||||
},
|
||||
updateLocation: (
|
||||
location: string /*目标地址*/,
|
||||
replace: boolean /*是replace,还是push?*/
|
||||
) => {
|
||||
// 用来更新地址栏
|
||||
},
|
||||
|
||||
jumpTo: (location:string/*目标地址*/) => {
|
||||
// 页面跳转, actionType: link、url 都会进来。
|
||||
},
|
||||
jumpTo: (location: string /*目标地址*/) => {
|
||||
// 页面跳转, actionType: link、url 都会进来。
|
||||
},
|
||||
|
||||
fetcher: ({
|
||||
url,
|
||||
method,
|
||||
data,
|
||||
config
|
||||
}:{
|
||||
url:string/*目标地址*/,
|
||||
method:'get' | 'post' | 'put' | 'delete'/*发送方式*/,
|
||||
data: object | void/*数据*/,
|
||||
config: object/*其他配置*/
|
||||
}) => {
|
||||
// 用来发送 Ajax 请求,建议使用 axios
|
||||
},
|
||||
notify: (type:'error'|'success'/**/, msg:string/*提示内容*/) => {
|
||||
// 用来提示用户
|
||||
},
|
||||
alert: (content:string/*提示信息*/) => {
|
||||
// 另外一种提示,可以直接用系统框
|
||||
},
|
||||
confirm: (content:string/*提示信息*/) => {
|
||||
// 确认框。
|
||||
}
|
||||
});}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
fetcher: ({
|
||||
url,
|
||||
method,
|
||||
data,
|
||||
config
|
||||
}: {
|
||||
url: string /*目标地址*/;
|
||||
method: 'get' | 'post' | 'put' | 'delete' /*发送方式*/;
|
||||
data: object | void /*数据*/;
|
||||
config: object /*其他配置*/;
|
||||
}) => {
|
||||
// 用来发送 Ajax 请求,建议使用 axios
|
||||
},
|
||||
notify: (
|
||||
type: 'error' | 'success' /**/,
|
||||
msg: string /*提示内容*/
|
||||
) => {
|
||||
// 用来提示用户
|
||||
},
|
||||
alert: (content: string /*提示信息*/) => {
|
||||
// 另外一种提示,可以直接用系统框
|
||||
},
|
||||
confirm: (content: string /*提示信息*/) => {
|
||||
// 确认框。
|
||||
}
|
||||
}
|
||||
)}
|
||||
</div>
|
||||
);
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user