conviva-fluid-ui

Fluid-UI is a playground for creating react component library

Usage no npm install needed!

<script type="module">
  import convivaFluidUi from 'https://cdn.skypack.dev/conviva-fluid-ui';
</script>

README

conviva-ui

Codacy Badge Codacy Badge

System requirement

Node: ^14.16.1

Storybook

https://conviva-fluid-ui.netlify.app

Install

npm install

Features

  • Enterprise-class UI designed for Conviva Applications.
  • Powerful theme customization in every detail.
  • Written in TypeScript with predictable static types.
  • Whole package of design resources and development tools.

Usage

One time AppWrapper to get the theming.

import { AppWrapper } from 'conviva-fluid-ui';
import { App } from './App';

const Root = () => (
  <App>
    <AppWrapper>
      /**
       * Rest of the App
      */
    </AppWrapper>
  </App>

Button Example

import { Button } from 'conviva-fluid-ui';

const Example = () => <Button type="primary">Button</Button>;

TypeScript

conviva-fluid-ui is written in TypeScript with complete definitions.

Development

Clone locally:


$ git clone git@github.com:Conviva-Internal/fluid-ui.git
$ cd fluid-ui
$ npm install
$ npm run storybook

Open your browser and visit http://localhost:6006/

We welcome all contributions. Please read our CONTRIBUTING.md first. You can submit any ideas as pull requests or as GitHub issues. If you'd like to improve code, check out the Development Instructions and have a good time! :)

Roadmap

Roadmap contains a detailed discussion of what we are building and what is in pipeline.