You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: LICENSE
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Office UI Fabric React
1
+
Fluent UI React
2
2
3
3
Copyright (c) Microsoft Corporation
4
4
@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
12
12
13
13
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14
14
15
-
Note: Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms listed at https://aka.ms/fabric-assets-license
15
+
Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license
Fluent UI React is a collection of robust React-based components designed to make it simple for you to create consistent web experiences using the Fluent Design Language.
13
14
14
-
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.
@@ -25,26 +24,26 @@ Please see the [wiki](https://github.com/microsoft/fluentui/wiki).
25
24
26
25
## Contents
27
26
28
-
-[Using Fabric React](#using-fabric-react)
27
+
-[Using Fluent UI React](#using-fluent-ui-react)
29
28
-[Starter apps](#starter-apps)
30
29
-[Integrating in your project](#integrating-in-your-project)
31
30
-[Version policy](#version-policy)
32
31
-[Browser support](#browser-support)
33
32
-[Right-to-left support](#right-to-left-support)
34
33
-[Server-side rendering](#server-side-rendering)
35
34
-[Advanced usage](#advanced-usage)
36
-
-[Contribute to Fabric React](#contribute-to-fabric-react)
35
+
-[Contribute to Fluent UI React](#contribute-to-fluent-ui-react)
37
36
-[Building the repo](#building-the-repo)
38
37
-[Testing](#testing)
39
38
-[Advanced building tips](#advanced-building-tips)
40
39
-[Licenses](#licenses)
41
40
-[Changelog](#changelog)
42
41
43
-
## Using Fabric React
42
+
## Using Fluent UI React
44
43
45
44
### Starter apps
46
45
47
-
To create a simple starter app using Fabric components, [install the latest LTS node.js](https://nodejs.org), then run:
46
+
To create a simple starter app using Fluent UI components, [install the latest LTS node.js](https://nodejs.org), then run:
48
47
49
48
```
50
49
npm init uifabric
@@ -68,51 +67,51 @@ How to integrate components into your project depends heavily on your setup. The
68
67
Within an npm project, you should install the package and save it as a dependency:
69
68
70
69
```
71
-
npm i office-ui-fabric-react
70
+
npm i @fluentui/react
72
71
73
72
# Or, use yarn
74
-
yarn add office-ui-fabric-react
73
+
yarn add @fluentui/react
75
74
```
76
75
77
-
This will add the package as a dependency in your `package.json` file and download it under `node_modules/office-ui-fabric-react`.
76
+
This will add the package as a dependency in your `package.json` file and download it under `node_modules/@fluentui/react`.
78
77
79
78
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:
ReactDOM.render(<PrimaryButton>I am a button.</PrimaryButton>, document.getElementById('root'));
87
86
```
88
87
89
88
### Version policy
90
89
91
-
Fabric React adheres to [semantic versioning](http://www.semver.org/). 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.
90
+
Fluent UI React adheres to [semantic versioning](http://www.semver.org/). However, we only consider constructs directly importable at the package level or from files at the root (e.g. `@fluentui/react/lib/Utilities` or `@fluentui/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.
92
91
93
92
### Browser support
94
93
95
-
Fabric React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the [browser support doc](https://github.com/microsoft/fluentui/wiki/Browser-Support) for more information.
94
+
Fluent UI React supports all evergreen browsers, with IE 11 as the min-bar version of Internet Explorer. See the [browser support doc](https://github.com/microsoft/fluentui/wiki/Browser-Support) for more information.
96
95
97
96
### Right-to-left support
98
97
99
98
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:
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](https://github.com/microsoft/fluentui/wiki/Server-side-rendering-and-browserless-testing) for examples of how to handle this.
108
+
Fluent UI React 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](https://github.com/microsoft/fluentui/wiki/Server-side-rendering-and-browserless-testing) for examples of how to handle this.
110
109
111
110
### Advanced usage
112
111
113
112
For info about advanced usage including module- vs. path-based imports, using an AMD bundler like RequireJS, and deployment features, see our [advanced documentation](https://github.com/microsoft/fluentui/wiki/Advanced-Usage).
114
113
115
-
## Contribute to Fabric React
114
+
## Contribute to Fluent UI React
116
115
117
116
Please take a look at our [contribution guidelines](https://github.com/microsoft/fluentui/wiki/Contributing) for more info. Also read [Contribute bug fixes](https://github.com/microsoft/fluentui/wiki/Bug-Fixes) and [Contribute new component](https://github.com/microsoft/fluentui/wiki/New-Components).
118
117
@@ -123,12 +122,12 @@ Before you get started, **make sure you have read the [Git branch setup instruct
123
122
To view the documentation including examples, contracts, component status, and to add functionality or fix issues locally, you can:
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.
130
+
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.
132
131
133
132
To build and run tests for all packages in the repo, run `yarn build` from the root.
134
133
@@ -144,9 +143,9 @@ For info about testing, see our [testing documentation](https://github.com/micro
144
143
145
144
## Licenses
146
145
147
-
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.
146
+
All files on the Fluent UI React GitHub repository are subject to the MIT license. Please read the License file at the root of the project.
148
147
149
-
Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms of the [assets license agreement](https://aka.ms/fabric-assets-license).
148
+
Usage of the fonts and icons referenced in Fluent UI React React is subject to the terms of the [assets license agreement](https://aka.ms/fluentui-assets-license).
Copy file name to clipboardexpand all lines: apps/fabric-website-resources/LICENSE
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Office UI Fabric React
1
+
Fluent UI
2
2
3
3
Copyright (c) Microsoft Corporation
4
4
@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
12
12
13
13
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14
14
15
-
Note: Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms listed at https://aka.ms/fabric-assets-license
15
+
Note: Usage of the fonts and icons referenced in Fluent UI React is subject to the terms listed at https://aka.ms/fluentui-assets-license
**Local demo app for office-ui-fabric-react controls**
3
+
**Local demo app for @fluentui/react controls**
4
4
5
-
This package contains the demo app that runs when you do `yarn start` from the root of the Fabric repo or from the `office-ui-fabric-react` package.
5
+
This package contains the demo app that runs when you do `yarn start` from the root of the Fluent UI repo or from the `office-ui-fabric-react` package.
6
6
7
-
To see a live version of this app, go to https://aka.ms/fabricdemo and choose a version.
7
+
To see a live version of this app, go to https://aka.ms/fluentdemo and choose a version.
8
8
9
-
See the [readme](https://github.com/microsoft/fluentui) for more information about Fabric and instructions for getting started with development, including how to run this app locally.
9
+
See the [readme](https://github.com/microsoft/fluentui) for more information about Fluent UI and instructions for getting started with development, including how to run this app locally.
Copy file name to clipboardexpand all lines: apps/fabric-website-resources/src/docs/GettingStartedOverview.md
+9-10
Original file line number
Diff line number
Diff line change
@@ -1,6 +1,6 @@
1
1
## Overview
2
2
3
-
Fabric React components are built as production-ready, generalized, documented, and reusable components to be used in Microsoft products. This enables us and our partners to more easily build great applications without spending a ton of time implementing the same things over and over.
3
+
Fluent UI React components are built as production-ready, generalized, documented, and reusable components to be used in Microsoft products. This enables us and our partners to more easily build great applications without spending a ton of time implementing the same things over and over.
4
4
5
5
Each component is designed to be RTL-friendly, keyboard accessible, screen reader-friendly, themeable, and generalized. TypeScript definition files are also included, so if you use TypeScript (which isn't a requirement), you will get compiler validation and using an editor like VS Code, you'll get intellisense. Each component is exported as a named module that can be easily imported in your code, allowing your external bundler to create small bundles that include just what you need.
6
6
@@ -11,18 +11,17 @@ Integrating components into your project depends heavily on your setup. The reco
11
11
Within an npm project, you should install the package and save it as a dependency:
12
12
13
13
```bash
14
-
npm install --save office-ui-fabric-react
14
+
npm install --save @fluentui/react
15
15
```
16
16
17
-
This will add the fabric-react project as a dependency in your package.json file, and will drop the project under node_modules/office-ui-fabric-react.
17
+
This will add the `@fluentui/react` project as a dependency in your package.json file, and will drop the project under `node_modules/@fluentui/react`.
18
18
19
-
The library includes commonjs entry points under the lib folder. To use a control, you should be able to import it and use it in your render method. Note that wrapping your application in the Fabric component is required to support RTL, keyboard focus and other features.
19
+
The library includes commonjs entry points under the `lib-commonjs` folder. To use a control, you should be able to import it and use it in your render method. Note that wrapping your application in the `<Fabric>` component is required to support RTL, keyboard focus and other features.
While it is possible to import all components as named imports from the main module entry point, it is not recommended to do so without using a bundler that supports es6 tree shaking. In other words, if you import the Button component like this:
39
38
40
39
```tsx
41
-
import { Button } from'office-ui-fabric-react';
40
+
import { Button } from'@fluentui/react';
42
41
```
43
42
44
43
...this would work, but then unless you are using a tree-shaking bundler such as Rollup.js or Webpack 2, Webpack will assume you want every module exported from the main entry file to be included in your final bundle, which produces unnecessary large bundles and slows your page load down. Instead you can import the specific paths to trim down your bundle size:
Copy file name to clipboardexpand all lines: apps/fabric-website/LICENSE
+2-2
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
Office UI Fabric React
1
+
Fluent UI
2
2
3
3
Copyright (c) Microsoft Corporation
4
4
@@ -12,4 +12,4 @@ The above copyright notice and this permission notice shall be included in all c
12
12
13
13
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
14
14
15
-
Note: Usage of the fonts referenced on Office UI Fabric files is subject to the terms listed at https://aka.ms/fabric-assets-license
15
+
Note: Usage of the fonts referenced on Fluent UI files is subject to the terms listed at https://aka.ms/fluentui-assets-license
**The official website for the UI Fabric project.**
3
+
**The official website for the Fluent UI project.**
4
4
5
-
UI Fabric is a collection of projects that represent the Fluent design language in code. This website helps document the components and styles that make up Fabric.
5
+
Fluent UI is a collection of projects that represent the Fluent design language in code. This website helps document the components and styles that make up Fluent UI.
6
6
7
7
## Build the website
8
8
9
-
See the [readme](https://github.com/microsoft/fluentui) for instructions on getting started with Fabric development.
9
+
See the [readme](https://github.com/microsoft/fluentui) for instructions on getting started with Fluent UI development.
10
10
11
11
Once your repo is set up, run the following to start a local copy of the website. (Be sure to **start from the root of the repo**, not the `fabric-website` folder.)
Copy file name to clipboardexpand all lines: apps/fabric-website/Third Party Notices.txt
+2-2
Original file line number
Diff line number
Diff line change
@@ -46,7 +46,7 @@ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLI
46
46
47
47
------------
48
48
49
-
Office UI Fabric
49
+
Fluent UI
50
50
51
51
Copyright (c) Microsoft Corporation
52
52
@@ -59,4 +59,4 @@ The above copyright notice and this permission notice shall be included in all c
59
59
60
60
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
61
61
62
-
Note: Usage of the fonts referenced on Office UI Fabric files is subject to the terms listed at https://aka.ms/fabric-assets-license
62
+
Note: Usage of the fonts referenced on Fluent UI files is subject to the terms listed at https://aka.ms/fluentui-assets-license
0 commit comments