sycho / flarum-uikit

为扩展开发者提供的前端工具。

维护者

详细信息

github.com/SychO9/flarum-uikit

源代码

问题

资助包维护！
其他

安装：8,697

依赖关系: 6

建议者: 0

安全: 0

星标: 2

关注者: 1

分支: 0

开放问题: 0

语言：TypeScript

v0.2.0 2021-08-31 11:04 UTC

Requires

MIT 3a796df5cf53e1e6c7dae61e192afb7610204158

This package is auto-updated.

Last update: 2024-08-29 05:19:15 UTC

README

latest version flarum version mit license downloads donate

Flarum UiKit，为扩展开发者提供可重用的前端工具。（不是扩展）

使用方法

使用包的扩展器来注册其资源。

extend.php

return [
    new SychO\UiKit\Extend\Register,
];

example.js

import ProgressBar from 'flarum/uikit/common/ProgressBar';
import Label from 'flarum/uikit/common/Label';
import LabelGroup from 'flarum/uikit/common/LabelGroup';
import Input from 'flarum/uikit/common/Input';

import DiscussionSearch from 'flarum/uikit/forum/DiscussionSearch';

/**
 * @param mini bool           small sized
 * @param alternate bool      works with backgrounds using control-bg background color
 * @param progress number     percentage
 * @param className string
 */
<ProgressBar fancy={true} mini={false} alternate={false} progress={93} />

/**
 * @param color string
 */
<Label color="red">Text</Label>

/**
 * Container for a group of labels
 */
<LabelGroup></LabelGroup>

/**
 * @param icon string         fontawesome icon
 * @param className string
 * ...attrs:    other attributes
 */
<Input icon="fas fa-user" className="Input--example"/>

/**
 * @param state GlobalSearchState
 * @param ignore number
 * @param onSelect (discussion: Discussion) => void
 */
<DiscussionSearch state={} ignore={485} onSelect={(discussion) => ...} />

安装

$ composer require sycho/flarum-uikit:^0.2.0

更新

$ composer update sycho/flarum-uikit:^0.2.0

链接

许可证

MIT 许可证。