feat: 删除无用 Readme
This commit is contained in:
parent
625f4e670b
commit
131a4bd675
|
@ -1,90 +0,0 @@
|
|||
## 如何将组件添加至 Omi-Admin
|
||||
|
||||
## 创建组件
|
||||
|
||||
在 omi/package/admin/src/components 目录下创建 name-component.tsx
|
||||
|
||||
使用目录下的 `example-component.tsx` 进行修改,添加你的组件展示页面
|
||||
|
||||
``` js
|
||||
import { WeElement, h, tag } from 'omi'
|
||||
import { tw, sheet } from 'omi-twind'
|
||||
import '../docs/admin-docs'
|
||||
import './code-demo'
|
||||
import './code-demo/container'
|
||||
|
||||
// 引入你的组件
|
||||
// TODO
|
||||
// import '@omiu/name'
|
||||
|
||||
interface Props {}
|
||||
|
||||
// TODO
|
||||
const tagName = 'name-component'
|
||||
declare global {
|
||||
namespace JSX {
|
||||
interface IntrinsicElements {
|
||||
[tagName]: Omi.Props & Props
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@tag(tagName)
|
||||
export default class extends WeElement<Props> {
|
||||
static css = [sheet.target]
|
||||
|
||||
// TODO
|
||||
mdA =
|
||||
`
|
||||
\`\`\`html
|
||||
<div>example</div>
|
||||
\`\`\`
|
||||
`
|
||||
|
||||
installed() {}
|
||||
|
||||
render() {
|
||||
|
||||
return (
|
||||
<code-demo-container>
|
||||
<code-demo
|
||||
title="例子"
|
||||
describe={'不同类型的标签'}
|
||||
// TODO
|
||||
code={this.mdA}
|
||||
>
|
||||
<div slot="demo" class={tw`px-5 py-5`}>
|
||||
{/* TODO */}
|
||||
<div>example</div>
|
||||
</div>
|
||||
</code-demo>
|
||||
</code-demo-container>
|
||||
)
|
||||
}
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
## 国际化中添加组件
|
||||
|
||||
在 `omi/package/admin/src/l10n/zh` 及 `omi/package/admin/src/l10n/en` 中加入
|
||||
|
||||
```js
|
||||
// omi/package/admin/src/l10n/en
|
||||
Name:"example"
|
||||
// omi/package/admin/src/l10n/zh
|
||||
Name:"例子"
|
||||
```
|
||||
|
||||
## 将组件展示页加入 Admin 路由 (支持自动加入了)
|
||||
|
||||
```js
|
||||
components.map((componentName: string) =>
|
||||
route(`/${componentName}-component`, () => {
|
||||
//lazy load
|
||||
import(`./components/components/${componentName}-component.tsx`).then(
|
||||
() => rootEl.transitionTo(`${componentName}-component`)
|
||||
)
|
||||
})
|
||||
)
|
||||
```
|
Loading…
Reference in New Issue