Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nachos-ui/nachos-ui
Nachos UI is a React Native component library.
https://github.com/nachos-ui/nachos-ui
react react-native react-native-web uikit web
Last synced: 25 days ago
JSON representation
Nachos UI is a React Native component library.
- Host: GitHub
- URL: https://github.com/nachos-ui/nachos-ui
- Owner: nachos-ui
- License: mit
- Created: 2017-01-30T14:22:09.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2021-03-12T10:42:57.000Z (over 3 years ago)
- Last Synced: 2024-04-21T15:11:49.168Z (7 months ago)
- Topics: react, react-native, react-native-web, uikit, web
- Language: JavaScript
- Homepage: https://avocode.com/nachos-ui/
- Size: 1.44 MB
- Stars: 2,067
- Watchers: 34
- Forks: 120
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-react-native - nachos-ui ★1684 - NACHOS UI kit for React Native. Pick from a bunch of pre-coded UI components ready for your next kick-ass app in JavaScript or React. (Components / UI)
- awesome-uikit - ~~Nachos UI~~ - ui/nachos-ui.svg?label=" /> - Nachos UI is a React Native component library. [![Open-Source Software][OSS Icon]](https://github.com/nachos-ui/nachos-ui) (Mobile UI Components / React Native)
README
[](https://travis-ci.org/avocode/nachos-ui)
## Intro
Nachos UI is a React Native component library. [Read more](https://medium.com/avocode-stories/my-experience-of-building-nachos-ui-kit-for-react-native-c8307500b8a4#.sh5cvk242) about how we built it on Medium.
### Features:
- Over 30 UI components
- Customizable UI components
- Works on **Web** thanks to [React Native for Web](https://github.com/necolas/react-native-web)
- Jest [Snapshot Testing](http://facebook.github.io/jest/docs/snapshot-testing.html)
- Uses [Prettier](https://github.com/jlongster/prettier) an opinionated JavaScript formatter.
- Uses [Yarn](https://yarnpkg.com/)
## Getting started
> **Requires React Native 0.40 and higher.**
```
$ npm install --save nachos-ui
```
OR
```
$ yarn add nachos-ui
```
The ThemeProvider component should be set at the highest level of your app. If it is not, Nachos UI components will NOT render.
```
import { ThemeProvider } from "nachos-ui";
export default (App = () => (
));
```
```jsx
import React from 'react'
import { View } from 'react-native'
import { Button } from 'nachos-ui'
const App = () => {
return (
Button
)
}
```
## Documentation
Visit the documentation at https://avocode.com/nachos-ui/docs/ with technical information about each component.
## Contributing
**Contributions are always welcome!** Before contributing, please read our [Code Of Conduct](https://github.com/avocode/nachos-ui/blob/master/CODE_OF_CONDUCT.md).
Read [Contributing](https://github.com/avocode/nachos-ui/blob/master/CONTRIBUTING.md).
## Developers
To play with Nachos UI locally first clone the repository:
```
$ git clone [email protected]:avocode/nachos-ui.git
```
Ideally use Yarn to install your dependencies. It's fast and consistent:
```
$ yarn install
```
To run the iOS simulator run:
```
$ yarn run start
```
To run the Web version:
```
$ yarn run start:web
```
## License
Nachos UI is open source and released under the [MIT License](https://github.com/avocode/nachos-ui/blob/master/LICENSE).
## Thanks!
- [Vacuumlabs](https://vacuumlabs.com/)
- [Polgár András](https://github.com/azazdeaz)
- [Oliver Drahota](https://github.com/csidro)