Giter VIP home page Giter VIP logo

flarum-uikit's Introduction

Flarum UiKit

latest version flarum version mit license downloads donate

Flarum UiKit with reusable frontend utilities for extension developers. (Not An Extension)

Usage

Use the package's extender to register its resources.

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) => ...} />

Installation

$ composer require sycho/flarum-uikit:^0.2.0

Updating

$ composer update sycho/flarum-uikit:^0.2.0

Links

License

The MIT License.

flarum-uikit's People

Contributors

sycho9 avatar

Stargazers

 avatar  avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.