@samsunginternet/oneui-web
v0.0.1
Published
One UI Web is the Samsung One UI implementation in CSS
Downloads
9
Readme
One UI Web
One UI Web is a framework inspired by the Samsung One UI Interface.
The goal is simplify the creation of mobile web apps with the One UI’s user experience, as well as to optimise your web apps for Samsung mobile.
One UI aims to ensure a consistent user experience within a single device and also a unified user experience among different mobile devices. Even if the user’s new device runs on a different platform, they can be provided with the user experience optimised for the device.
One UI is built to to help you focus on what really matters, with hardware and software working in harmony to bring you what you need right when you need it.
Installation / Usage
- Get One UI Web
git clone https://github.com/SamsungInternet/OneUI-Web.git
- Download the latest release
- Add the
one-ui
folder to your project files - Include the CSS in your project
Please also check the Getting started part in the documentation: http://samsunginter.net/OneUI-Web/#/getting-started/quickstart
Documentation
We've built a beautiful documentation just for you: http://samsunginter.net/OneUI-Web/
This documentation is using DocsifyJS. You can also run it locally by following the steps bellow.
- Install docsify
npm i docsify-cli -g
- Run the local server with
docsify server
in the gh-page branch - Finnaly can preview the documentation in your browser on
http://localhost:3000
Bugs and feature request
Found a Bug ? Have a feature request ? You can open a new issue and we will try our best to fix it.
Don't forget that you can also contribute <3
Contributing
Pull requests are welcome :) For major changes, please open an issue first to discuss what you would like to change.
MIT License
A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.
See the LICENSE file to learn more.