dc062498d6
* bump beachball version to one with prepublish fix * update beachball hook to use new prepublish strategy * add gitattributes for auto text line endings * update values * renormalize files * Change files |
||
|---|---|---|
| .ado | ||
| .vscode | ||
| apps | ||
| assets | ||
| change | ||
| packages | ||
| scripts | ||
| .dockerignore | ||
| .eslintignore | ||
| .eslintrc.json | ||
| .gitattributes | ||
| .gitignore | ||
| CODE_OF_CONDUCT.md | ||
| LICENSE | ||
| README.md | ||
| api-extractor.json | ||
| beachball.config.js | ||
| lerna.json | ||
| package.json | ||
| prettier.config.js | ||
| tsconfig.json | ||
| yarn.lock | ||
README.md
FluentUI React Native
FluentUI React Native is a javascript component library that provides developers with controls that are part of the Fluent Design System. These controls are built on React Native and fully customizable.
Getting Started
If you have an existing React Native project, it's easy to begin using FluentUI React Native. If you need to setup a new React Native project, please see the React Native Windows Getting Started documentation.
Prerequisites
Install FluentUI React Native into an existing project
Navigate to the root folder of your project, and use npm to install the package:
npm i @fluentui/react-native
After successful installation, you can test the package by importing components at the top of your app's entry file, e.g. App.js:
import { Checkbox } from '@fluentui/react-native';
Once you have the package installed, check out our Hello World Fluent page to start writing code (Coming Soon).
Documentation
Components and Controls
Our component documentation is hosted in a separate repository, Microsoft FluentUI Site that will be published to its own website (Coming Soon).
Theming framework
Our FluentUI framework documentation is found in this repository alongside the implementation.
- Theming Overview
- StyleSheets
- Customizing Theme Settings
- Theme Registry
- Tokens
- Settings and Slots
- Compose and Composable
Developing in the repo
Yarn + Lerna
This repo is set up as a monorepo using Lerna + Yarn workspaces. The yarn commands will trigger the lerna commands which will execute yarn commands in each package. To install yarn, please follow instructions in the Yarn documentation.
Setup your development environment
To start developing in the repository you can:
git clone https://github.com/microsoft/fluentui-react-native.gitcd fluentui-react-nativeyarnyarn build
After a successful yarn build, you can explore FluentUI Tester, our demo application to play with each of the controls. To run FluentUI Tester, please follow instructions in the FluentUI Tester readme.
Beachball
This repo manages semantic versioning and publishing using Beachball. When contributing, make sure to run the following before making a pull request:
yarn changewill take you through a command line wizard to generate change files- Make sure to commit and push the newly generated change file
Contributing
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.