Professional Documents
Culture Documents
Exam 370493011O-881
Exam 370493011O-881
smith / office-ui-fabric-react
forked from microsoft/fluentui
Star
Watch
Code
Pull requests
Actions
Projects
Security
Insights
master
Go to file
View code
README.md
Fabric React is a collection of robust React-based components designed to make it simple for you to create consistent
web experiences using the Office Design Language.
Fabric 7 (the next major version of Fabric) is under development. Roadmap, breaking changes, and more details
available in the wiki.
Who uses UI Fabric?
Contents
Using Fabric React
Version policy
Browser support
Right-to-left support
Server-side rendering
Advanced usage
Contribute to Fabric React
Building the repo
Testing
Advanced building tips
Licenses
Changelog
This will add the package as a dependency in your package.json file and download it under node_modules/office-
ui-fabric-react .
The library includes ES2015 module entry points under the lib folder (use lib-amd if you need AMD, or lib-
commonjs if you need commonjs). To use a control, import it and then use it in your render method:
Version policy
Fabric React adheres to semantic versioning. However, we only consider constructs directly importable at the package
level or from files at the root (e.g. office-ui-fabric-react/lib/Utilities or office-ui-fabric-react/lib-
amd/Styling ) to be part of our API surface. Everything else is considered package-internal and may be subject to
changes, moves, renames, etc.
Browser support
Fabric React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the browser
support doc for more information.
Right-to-left support
All components can render in LTR or RTL, depending on the dir attribute set on the html element ( dir="rtl" will
flip the direction of everything). You can also use the setRTL API if you don't have control over the html element's
rendering. Example:
setRTL(true);
Server-side rendering
Fabric components can be rendered in a server-side Node environment (or used in tests which run in an SSR-like
environment), but it requires customizing how styles and SCSS files are loaded. See the server-side rendering
documentation for examples of how to handle this.
Advanced usage
For info about advanced usage including module- vs. path-based imports, using an AMD bundler like RequireJS, and
deployment features, see our advanced documentation.
This will start a demo page from the office-ui-fabric-react package folder, which will open a web browser with the
example page. You can make changes to the code which will automatically build and refresh the page using live-reload.
To build and run tests for all packages in the repo, run npm run build from the root.
To build individual packages within the packages/* or apps/* folders, cd to the relevant folder and run npm run
build . Note that because the packages are symlinked together, you must manage building dependencies in the right
order, or use the rush tool to build to the specific package you want. (See advanced tips below.)
Testing
For info about testing, see our testing documentation.
To use Rush to build, you can run rush build , which will incrementally build the entire repo (only build what has
changed since the last build). If you don't have Rush globally installed, you can use the command npm run buildfast ,
which abstracts rush build .
To build up to a specific project, use the --to <package> argument. For example, to build up to office-ui-fabric-
react , run:
Licenses
All files on the Office UI Fabric React GitHub repository are subject to the MIT license. Please read the License file at the
root of the project.
Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms of the assets license agreement.
Changelog
We use GitHub Releases to manage our releases, including the changelog between every release. View a complete list of
additions, fixes, and changes on the releases page.
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.
Releases
2,456 tags
Languages