/wicara

The component library powering the Kata.ai platform.

Primary LanguageTypeScriptApache License 2.0Apache-2.0

Wicara

wicara /wi·ca·ra/ (noun)
the expression of or the ability to express thoughts and feelings by articulate sounds.

Build Status codecov Build Status


Wicara (previously kata-kit) is an implementation of Aksara using the React framework. It is the true implementation of Aksara in raw code form, designed to communicate with users and bring delightful experiences. Wicara is the designation for Aksara React components.

Note: Wicara is still in beta.


Contributing

Wicara is developed by the help of developers like you! Please read our Contributing Guidelines to get started on developing Wicara.

This project is bound by a Code of Conduct.

Usage

Quickstart

Check out kata-ai/wicara-starter.

Prerequisites

Wicara requires styled-components v4+. First, install the core Wicara theme/reset package and styled-components.

# yarn
$ yarn add styled-components @kata-kit/theme @kata-kit/reset

# npm
$ npm install --save styled-components @kata-kit/theme @kata-kit/reset

At the bare minimum, you should at least import the global CSS reset provided by Wicara.

import { KataReset } from '@kata-kit/reset';

const App = ({ children }) => <KataReset>{children}</KataReset>;

Example

Wicara is built in React, with styling done in styled-components. To use these components, import them as follows:

// Example for `<Button />` component.

import * as React from 'react';
import { Button } from '@kata-kit/button';

export default () => <Button>Push Me</Button>;

License

This is a monorepo, which means different packages can have different licenses.

By default, the root level of this repo, as well as the demo site, are licensed under the Apache 2.0 license. While most components use the same license, please note that some packages (like our assets package) may use a different license. Any overriding licenses for each package will be mentioned in the LICENSE file located at the root of each package.

Copyright (c) 2018 Kata.ai and/or contributors. All rights reserved.

Maintainers