README

conviva-ui

System requirement

Node: ^14.16.1

Storybook

https://conviva-internal.github.io/conviva-ui/

Install

npm install conviva-ui

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-ui';
import { App } from './App';

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

One time addition for Google fonts

<link rel="preconnect" href="https://fonts.gstatic.com" />
<link
  href="https://fonts.googleapis.com/css2?family=Open+Sans&display=swap"
  rel="stylesheet"
/>

Live working example: https://codesandbox.io/s/using-conviva-fluid-ui-ccg07?file=/src/App.js

Button Example

import { Button } from 'conviva-ui';

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

Module Stats

https://conviva-internal.github.io/conviva-ui/stats.html

TypeScript

conviva-ui is written in TypeScript with complete definitions.

CONTRIBUTING

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! :)

Before contributing make sure you have completed all of these learning resources.

Roadmap

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

Usage no npm install needed!