Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kata-ai/aksara-ui
Aksara Design System, from Kata.ai.
https://github.com/kata-ai/aksara-ui
aksara-ui component-library design-system react typescript ui-kit
Last synced: about 11 hours ago
JSON representation
Aksara Design System, from Kata.ai.
- Host: GitHub
- URL: https://github.com/kata-ai/aksara-ui
- Owner: kata-ai
- License: apache-2.0
- Created: 2018-05-17T15:29:12.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T15:47:12.000Z (almost 2 years ago)
- Last Synced: 2024-10-09T20:36:03.451Z (4 months ago)
- Topics: aksara-ui, component-library, design-system, react, typescript, ui-kit
- Language: TypeScript
- Homepage: https://aksara.kata.ai/
- Size: 10.5 MB
- Stars: 193
- Watchers: 18
- Forks: 26
- Open Issues: 28
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-indo-projects - Aksara UI - Aksara UI is an implementation of Aksara using the React framework. (JavaScript)
- awesome-made-by-indonesian - Aksara UI - `Aksara Design System, from Kata.ai.` *by [kata.ai](https://github.com/kata-ai)* (A)
- made-in-indonesia - Aksara UI - `Aksara Design System, from Kata.ai.` *by [kata.ai](https://github.com/kata-ai)* (A)
- awesome-indonesia-repo - Aksara UI - Aksara UI is an implementation of Aksara using the React framework. (JavaScript)
README
aksara /ak·sa·ra/ noun
is a system of visual symbol, usually stamped on paper or other media (stone, wood, leaf, and fabric), to express thoughts and ideas.
---
**Aksara** is Kata.ai's design system. It contains foundations, voice and tone guidelines, component standards, and other guidelines that systematically improve quality, timeliness, and consistency to our product.
**Aksara UI** 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. Aksara UI is the designation for Aksara React components.
---
## Contributing
Aksara UI is developed by the help of developers like you! Please read our [Contributing Guidelines](CONTRIBUTING.md) to get started on developing Aksara UI.
This project is bound by a [Code of Conduct](CODE_OF_CONDUCT.md).
## Usage
### Prerequisites
Aksara UI requires `styled-components` v4+. First, install the core Aksara UI package, Aksara UI React icon library, and `styled-components`.
```bash
# yarn
$ yarn add styled-components @aksara-ui/react @aksara-ui/icons
# npm
$ npm install --save styled-components @aksara-ui/react @aksara-ui/icons
```
Then, you will need to apply the theme provider as well as the default global styles. Wrap your app inside the `AksaraProvider` to do so.
```jsx
import { AksaraProvider } from '@aksara-ui/react';
export default function MyApp({ children }) {
return {children};
}
```
If you would like to use additional styles for `AksaraProvider`, add the `disableInjection` prop to `AksaraProvider` and add your custom styles as follows.
```jsx
import { css } from 'styled-components';
import { AksaraProvider, injectGlobalStyles } from '@aksara-ui/react';
const styles = css`
[data-reach-tooltip] {
z-index: 1;
pointer-events: none;
position: absolute;
padding: 0.25em 0.5em;
box-shadow: 2px 2px 10px hsla(0, 0%, 0%, 0.1);
white-space: nowrap;
font-size: 85%;
background: #f0f0f0;
color: #444;
border: solid 1px #ccc;
}
`;
const { GlobalStyles } = injectGlobalStyles(styles);
export default function MyApp({ children }) {
return (
{children}
);
}
```
Once you've applied the provider, you can use Aksara UI components in your app. See the example below.
### Example
Aksara UI is built in React, with styling done in styled-components. To use these components, import them as follows:
```jsx
// Example for `` component.
import * as React from 'react';
import { Button } from '@aksara-ui/react';
export default function Component() {
return Push Me;
}
```
Read the [Storybook](https://aksara-ui.now.sh/) for more examples.
## Fonts
We use multiple fonts in Aksara UI:
- The system font stack, for all UI elements within the platform.
- The [**Inter**](https://rsms.me/inter/) font as our primary brand typeface.
### Using brand fonts
First, you should install the brand fonts into your project.
```bash
# yarn
$ yarn add typeface-inter
# npm
$ npm install --save typeface-inter
```
Then, in any typography component (e.g. `Text`, `Heading`), you can use the `brand` token in `fontFamily`.
```jsx
import * as React from 'react';
import { Heading } from '@aksara-ui/react';
export default function Component() {
return (
Heading Text
);
}
```
## License
All packages in this repoare released under the [Apache 2.0 license](LICENSE). Please note that some packages (like our fonts package) may contain third-party materials with different licences. Any third-party acknowledgements are outlined on the "Credits" section on each package's README.
Copyright (c) 2018 Kata.ai and/or contributors. All rights reserved.
## Maintainers
- Resi Respati ([@resir014](https://twitter.com/resir014)) – [Kata.ai](https://kata.ai)