Skip to content

Commit d1dedb9

Browse files
benfeelybenfeely
committed
Update to docs.
1 parent 299e4b4 commit d1dedb9

File tree

7 files changed

+170
-110
lines changed

7 files changed

+170
-110
lines changed

‎CHANGELOG.md‎

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Change Log
2+
3+
All notable changes to this project will be documented in this file.
4+
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
5+
6+
<a name="0.4.0"></a>
7+
# [0.4.0](https://github.com/Microsoft/angular-react/compare/03ca764...v0.4.0) (2018-08-16)
8+
Initial public release...
9+
10+
### Bug Fixes
11+
12+
* **core:** React-wrapped components inside inside ng-template don't re-render on changes ([#5](https://github.com/Microsoft/angular-react/issues/5)) ([299e4b4](https://github.com/Microsoft/angular-react/commit/299e4b4))
13+
14+
15+
### Features
16+
17+
* **command-bar:** add contrast and luminosity utilities ([#3](https://github.com/Microsoft/angular-react/issues/3)) ([6f002f9](https://github.com/Microsoft/angular-react/commit/6f002f9))
18+
19+
20+
### BREAKING CHANGES
21+
22+
* **n/a**
23+
24+
25+
26+
27+
<a name="<0.4.0"></a>
28+
# < 0.4.0
29+
30+
31+
### Features
32+
33+
* **core:** original core and fabric libraries including docs ([03ca764](https://github.com/Microsoft/angular-react/commit/03ca764))

‎CODE_OF_CONDUCT.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
2+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
3+
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.

‎CONTRIBUTING.md‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
# Contributing
2+
3+
This project welcomes contributions and suggestions. Most contributions require you to
4+
agree to a Contributor License Agreement (CLA) declaring that you have the right to,
5+
and actually do, grant us the rights to use your contribution. For details, visit
6+
https://cla.microsoft.com.
7+
8+
When you submit a pull request, a CLA-bot will automatically determine whether you need
9+
to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the
10+
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
11+
12+
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
13+
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
14+
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
15+
16+
## Pull Requests Reviews
17+
This is a simple guide to assist in reviewing Github pull requests locally within VS Code.
18+
19+
See: https://gist.github.com/piscisaureus/3342247
20+
Locate the section for your github remote in the `.git/config` file. It looks like this:
21+
22+
```
23+
[remote "origin"]
24+
fetch = +refs/heads/*:refs/remotes/origin/*
25+
url = git@github.com:joyent/node.git
26+
```
27+
28+
Now add the line `fetch = +refs/pull/*/head:refs/remotes/origin/pr/*` to this section. Obviously, change the github url to match your project's URL. It ends up looking like this:
29+
30+
```
31+
[remote "origin"]
32+
fetch = +refs/heads/*:refs/remotes/origin/*
33+
url = git@github.com:joyent/node.git
34+
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
35+
```
36+
37+
Now fetch all the pull requests:
38+
39+
```
40+
$ git fetch origin
41+
From github.com:joyent/node
42+
* [new ref] refs/pull/1000/head -> origin/pr/1000
43+
* [new ref] refs/pull/1002/head -> origin/pr/1002
44+
* [new ref] refs/pull/1004/head -> origin/pr/1004
45+
* [new ref] refs/pull/1009/head -> origin/pr/1009
46+
...
47+
```
48+
49+
To check out a particular pull request:
50+
51+
```
52+
$ git checkout pr/999
53+
Branch pr/999 set up to track remote branch pr/999 from origin.
54+
Switched to a new branch 'pr/999'
55+
```
56+
57+
To get latest changes to the PR:
58+
59+
```
60+
$ git checkout pr/1000
61+
$ git pull --tags origin refs/pull/1000/head
62+
From https://github.com/microsoft/angular-react
63+
* branch refs/pull/1000/head -> FETCH_HEAD
64+
Updating aab92e2..2896b73
65+
Fast-forward
66+
...
67+
```
68+
69+
Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin".

‎LICENSE‎

Lines changed: 17 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,21 @@
1-
MIT License
1+
Copyright (c) Microsoft Corporation. All rights reserved.
22

3-
Copyright (c) Microsoft Corporation. All rights reserved.
3+
MIT License
44

5-
Permission is hereby granted, free of charge, to any person obtaining a copy
6-
of this software and associated documentation files (the "Software"), to deal
7-
in the Software without restriction, including without limitation the rights
8-
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9-
copies of the Software, and to permit persons to whom the Software is
10-
furnished to do so, subject to the following conditions:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
1111

12-
The above copyright notice and this permission notice shall be included in all
13-
copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1414

15-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16-
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17-
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18-
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19-
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20-
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21-
SOFTWARE
22-
15+
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 14 additions & 69 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Industry trends, organizational pressures, and other factors can lead to mandate
66

77
Use of Angular-React allows consuming any React elements, but specifically Office UI Fabric, within an Angular [2+] application. The library of wrappers for Office UI Fabric simplifies the use of these components with Angular. However, any React code can make use of the custom Angular-React renderer.
88

9-
#### Quick links
9+
### Quick links
1010
[@angular-react/fabric](https://www.npmjs.com/package/@angular-react/fabric) |
1111
[Documentation, quick start, and guides][ard] |
1212
[Demo][ard-demo] |
@@ -18,7 +18,16 @@ Use of Angular-React allows consuming any React elements, but specifically Offic
1818
- Use React component libraries with Angular
1919
- Incrementally rewrite an Angular application into React (moving from atomic/leaf nodes upward into full features/pages until the entire app is re-written)
2020

21-
### Getting started
21+
## Libraries
22+
- [**core**][lib-core]: Includes the Renderer and supporting logic to render Angular components with React implementations as React components.
23+
- [**fabric**][lib-fab]: The light-weight Angular component wrappers that expose the Fabric React component api through common Angular components (including both imperative AND declrative syntax in many cases).
24+
25+
# Roadmap
26+
Initial work to prove the feasibility of adapting the Angular Renderer to output React managed components has concluded. We have moved beyond the initial simple Fabric components and expanded coverage to much of the available [Office UI Fabric][fab-c] component library.
27+
28+
In the coming months we will continue to refine the component implementations as we use the angular-react core and fabric libraries in 2 real-world consumer facing production applications.
29+
30+
## Getting started
2231

2332
See our [Getting Started Guide][getting-started]
2433
if you're building your first project with Angular-React.
@@ -30,70 +39,6 @@ You can look through the issues (which should be up-to-date on who is working on
3039
[ard-demo]: https://microsoft.github.io/angular-react/demo
3140
[getting-started]: https://microsoft.github.io/angular-react/docs/getting-started
3241
[fab]: https://developer.microsoft.com/en-us/fabric
33-
34-
## Contributing
35-
36-
This project welcomes contributions and suggestions. Most contributions require you to agree to a
37-
Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us
38-
the rights to use your contribution. For details, visit https://cla.microsoft.com.
39-
40-
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide
41-
a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions
42-
provided by the bot. You will only need to do this once across all repos using our CLA.
43-
44-
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
45-
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
46-
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
47-
48-
### Pull Requests
49-
See: https://gist.github.com/piscisaureus/3342247
50-
Locate the section for your github remote in the `.git/config` file. It looks like this:
51-
52-
```
53-
[remote "origin"]
54-
fetch = +refs/heads/*:refs/remotes/origin/*
55-
url = git@github.com:joyent/node.git
56-
```
57-
58-
Now add the line `fetch = +refs/pull/*/head:refs/remotes/origin/pr/*` to this section. Obviously, change the github url to match your project's URL. It ends up looking like this:
59-
60-
```
61-
[remote "origin"]
62-
fetch = +refs/heads/*:refs/remotes/origin/*
63-
url = git@github.com:joyent/node.git
64-
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
65-
```
66-
67-
Now fetch all the pull requests:
68-
69-
```
70-
$ git fetch origin
71-
From github.com:joyent/node
72-
* [new ref] refs/pull/1000/head -> origin/pr/1000
73-
* [new ref] refs/pull/1002/head -> origin/pr/1002
74-
* [new ref] refs/pull/1004/head -> origin/pr/1004
75-
* [new ref] refs/pull/1009/head -> origin/pr/1009
76-
...
77-
```
78-
79-
To check out a particular pull request:
80-
81-
```
82-
$ git checkout pr/999
83-
Branch pr/999 set up to track remote branch pr/999 from origin.
84-
Switched to a new branch 'pr/999'
85-
```
86-
87-
To get latest changes to the PR:
88-
89-
```
90-
$ git checkout pr/1000
91-
$ git pull --tags origin refs/pull/1000/head
92-
From https://github.com/microsoft/angular-react
93-
* branch refs/pull/1000/head -> FETCH_HEAD
94-
Updating aab92e2..2896b73
95-
Fast-forward
96-
...
97-
```
98-
99-
Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin".
42+
[fab-c]: https://developer.microsoft.com/en-us/fabric#/components
43+
[lib-core]: https://www.npmjs.com/package/@angular-react/core
44+
[lib-fab]: https://www.npmjs.com/package/@angular-react/fabric

‎libs/fabric/README.md‎

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,33 @@ High level stuff planned for Q2 2018 (April - June):
3737

3838
| Feature | Notes | Docs |
3939
|------------------|--------------------------------------------------------|--------------|
40-
| button | More features coming in 2018 | [Docs][0] |
41-
| dialog | More features coming in 2018 | [Docs][1] |
40+
| breadcrumb | Beta | [Docs][0] |
41+
| button | Beta | [Docs][0] |
42+
| callout | Beta | [Docs][0] |
43+
| choice-group | Beta | [Docs][0] |
44+
| combo-box | Beta | [Docs][0] |
45+
| command-bar | Heavily tested, most scenarios covered. | [Docs][0] |
46+
| contextual-menu | Beta | [Docs][0] |
47+
| date-picker | Beta | [Docs][0] |
48+
| dialog | Beta | [Docs][1] |
49+
| divider | Beta | [Docs][0] |
50+
| grouped-list | Beta | [Docs][0] |
51+
| hover-card | Beta | [Docs][0] |
52+
| icon | Beta | [Docs][0] |
53+
| image | Beta | [Docs][0] |
54+
| link | Beta | [Docs][0] |
55+
| message-bar | Beta | [Docs][0] |
56+
| modal | Beta | [Docs][0] |
57+
| panel | Beta | [Docs][0] |
58+
| persona | Beta | [Docs][0] |
59+
| pickers | Beta | [Docs][0] |
60+
| pivot | Beta | [Docs][0] |
61+
| search-box | Beta | [Docs][0] |
62+
| shimmer | Beta | [Docs][0] |
63+
| slider | Beta | [Docs][0] |
64+
| spinner | Beta | [Docs][0] |
65+
| toggle | Beta | [Docs][0] |
66+
| tooltip | Beta | [Docs][0] |
4267

4368
#### In progress, planned, and non-planned Fabric features
4469

0 commit comments

Comments
 (0)