https://github.com/sycho9/flarum-uikit

🎨 Frontend utilities for extension developers.
https://github.com/sycho9/flarum-uikit

components css flarum javascript library ui

Last synced: about 1 year ago
JSON representation

🎨 Frontend utilities for extension developers.

• Host: GitHub
• URL: https://github.com/sycho9/flarum-uikit
• Owner: SychO9
• License: mit
• Created: 2020-10-23T10:17:46.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2025-01-12T11:54:30.000Z (over 1 year ago)
• Last Synced: 2025-04-09T15:09:11.951Z (about 1 year ago)
• Topics: components, css, flarum, javascript, library, ui
• Language: TypeScript
• Homepage:
• Size: 504 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Flarum UiKit

[![latest version](https://img.shields.io/packagist/v/sycho/flarum-uikit.svg?style=flat-square)](https://packagist.org/packages/sycho/flarum-uikit)

![mit license](https://img.shields.io/badge/license-MIT-green.svg?style=flat-square&color=green)

![downloads](https://img.shields.io/packagist/dt/sycho/flarum-uikit?color=%23f28d1a&style=flat-square)

[![donate](https://img.shields.io/badge/donate-buy%20me%20a%20coffee-%23ffde39?style=flat-square)](https://www.buymeacoffee.com/sycho)

[Flarum](https://flarum.org) UiKit with reusable frontend utilities for extension developers. (***Not An Extension***)

## Usage

Use the package's extender to register its resources.

**extend.php**

```php

return [

    new SychO\UiKit\Extend\Register,

];

```

**example.js**

```jsx

import ProgressBar from 'ext:sycho/flarum-uikit/common/ProgressBar';

import Label from 'ext:sycho/flarum-uikit/common/Label';

import LabelGroup from 'ext:sycho/flarum-uikit/common/LabelGroup';

import DiscussionSearch from 'ext:sycho/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

 */

/**

 * @param color string

 */

Text

/**

 * Container for a group of labels

 */

/**

 * @param state GlobalSearchState

 * @param ignore number

 * @param onSelect (discussion: Discussion) => void

 */

 ...} />

```

## Installation

```ssh

$ composer require sycho/flarum-uikit:^0.3.0

```

## Updating

```ssh

$ composer update sycho/flarum-uikit:^0.3.0

```

## Links

* [GitHub](https://github.com/SychO9/flarum-uikit)

* [Packagist](https://packagist.org/packages/sycho/flarum-uikit)

## License

The MIT License.