Update to docs.
This commit is contained in:
Ben Feely
Родитель
299e4b41f0
Коммит
d1dedb975a
|
|
@ -0,0 +1,33 @@
|
|||
# Change Log
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
|
||||
|
||||
<a name="0.4.0"></a>
|
||||
# [0.4.0](https://github.com/Microsoft/angular-react/compare/03ca764...v0.4.0) (2018-08-16)
|
||||
Initial public release...
|
||||
|
||||
### Bug Fixes
|
||||
|
||||
* **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))
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **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))
|
||||
|
||||
|
||||
### BREAKING CHANGES
|
||||
|
||||
* **n/a**
|
||||
|
||||
|
||||
|
||||
|
||||
<a name="<0.4.0"></a>
|
||||
# < 0.4.0
|
||||
|
||||
|
||||
### Features
|
||||
|
||||
* **core:** original core and fabric libraries including docs ([03ca764](https://github.com/Microsoft/angular-react/commit/03ca764))
|
||||
|
|
@ -0,0 +1,3 @@
|
|||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
|
@ -0,0 +1,69 @@
|
|||
# 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.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., label, comment). Simply follow the
|
||||
instructions provided by the bot. You will only need to do this once across all repositories using our CLA.
|
||||
|
||||
This project has adopted the [Microsoft Open Source Code of Conduct](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/)
|
||||
or contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
## Pull Requests Reviews
|
||||
This is a simple guide to assist in reviewing Github pull requests locally within VS Code.
|
||||
|
||||
See: https://gist.github.com/piscisaureus/3342247
|
||||
Locate the section for your github remote in the `.git/config` file. It looks like this:
|
||||
|
||||
```
|
||||
[remote "origin"]
|
||||
fetch = +refs/heads/*:refs/remotes/origin/*
|
||||
url = git@github.com:joyent/node.git
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
[remote "origin"]
|
||||
fetch = +refs/heads/*:refs/remotes/origin/*
|
||||
url = git@github.com:joyent/node.git
|
||||
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
|
||||
```
|
||||
|
||||
Now fetch all the pull requests:
|
||||
|
||||
```
|
||||
$ git fetch origin
|
||||
From github.com:joyent/node
|
||||
* [new ref] refs/pull/1000/head -> origin/pr/1000
|
||||
* [new ref] refs/pull/1002/head -> origin/pr/1002
|
||||
* [new ref] refs/pull/1004/head -> origin/pr/1004
|
||||
* [new ref] refs/pull/1009/head -> origin/pr/1009
|
||||
...
|
||||
```
|
||||
|
||||
To check out a particular pull request:
|
||||
|
||||
```
|
||||
$ git checkout pr/999
|
||||
Branch pr/999 set up to track remote branch pr/999 from origin.
|
||||
Switched to a new branch 'pr/999'
|
||||
```
|
||||
|
||||
To get latest changes to the PR:
|
||||
|
||||
```
|
||||
$ git checkout pr/1000
|
||||
$ git pull --tags origin refs/pull/1000/head
|
||||
From https://github.com/microsoft/angular-react
|
||||
* branch refs/pull/1000/head -> FETCH_HEAD
|
||||
Updating aab92e2..2896b73
|
||||
Fast-forward
|
||||
...
|
||||
```
|
||||
|
||||
Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin".
|
||||
35
LICENSE
35
LICENSE
|
|
@ -1,22 +1,21 @@
|
|||
MIT License
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
|
||||
Copyright (c) Microsoft Corporation. All rights reserved.
|
||||
MIT License
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
in the Software without restriction, including without limitation the rights
|
||||
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
||||
copies of the Software, and to permit persons to whom the Software is
|
||||
furnished to do so, subject to the following conditions:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
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
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
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.
|
||||
83
README.md
83
README.md
|
|
@ -6,7 +6,7 @@ Industry trends, organizational pressures, and other factors can lead to mandate
|
|||
|
||||
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.
|
||||
|
||||
#### Quick links
|
||||
### Quick links
|
||||
[@angular-react/fabric](https://www.npmjs.com/package/@angular-react/fabric) |
|
||||
[Documentation, quick start, and guides][ard] |
|
||||
[Demo][ard-demo] |
|
||||
|
|
@ -18,7 +18,16 @@ Use of Angular-React allows consuming any React elements, but specifically Offic
|
|||
- Use React component libraries with Angular
|
||||
- Incrementally rewrite an Angular application into React (moving from atomic/leaf nodes upward into full features/pages until the entire app is re-written)
|
||||
|
||||
### Getting started
|
||||
## Libraries
|
||||
- [**core**][lib-core]: Includes the Renderer and supporting logic to render Angular components with React implementations as React components.
|
||||
- [**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).
|
||||
|
||||
# Roadmap
|
||||
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.
|
||||
|
||||
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.
|
||||
|
||||
## Getting started
|
||||
|
||||
See our [Getting Started Guide][getting-started]
|
||||
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
|
|||
[ard-demo]: https://microsoft.github.io/angular-react/demo
|
||||
[getting-started]: https://microsoft.github.io/angular-react/docs/getting-started
|
||||
[fab]: https://developer.microsoft.com/en-us/fabric
|
||||
|
||||
## 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.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., label, 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](https://opensource.microsoft.com/codeofconduct/).
|
||||
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
|
||||
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.
|
||||
|
||||
### Pull Requests
|
||||
See: https://gist.github.com/piscisaureus/3342247
|
||||
Locate the section for your github remote in the `.git/config` file. It looks like this:
|
||||
|
||||
```
|
||||
[remote "origin"]
|
||||
fetch = +refs/heads/*:refs/remotes/origin/*
|
||||
url = git@github.com:joyent/node.git
|
||||
```
|
||||
|
||||
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:
|
||||
|
||||
```
|
||||
[remote "origin"]
|
||||
fetch = +refs/heads/*:refs/remotes/origin/*
|
||||
url = git@github.com:joyent/node.git
|
||||
fetch = +refs/pull/*/head:refs/remotes/origin/pr/*
|
||||
```
|
||||
|
||||
Now fetch all the pull requests:
|
||||
|
||||
```
|
||||
$ git fetch origin
|
||||
From github.com:joyent/node
|
||||
* [new ref] refs/pull/1000/head -> origin/pr/1000
|
||||
* [new ref] refs/pull/1002/head -> origin/pr/1002
|
||||
* [new ref] refs/pull/1004/head -> origin/pr/1004
|
||||
* [new ref] refs/pull/1009/head -> origin/pr/1009
|
||||
...
|
||||
```
|
||||
|
||||
To check out a particular pull request:
|
||||
|
||||
```
|
||||
$ git checkout pr/999
|
||||
Branch pr/999 set up to track remote branch pr/999 from origin.
|
||||
Switched to a new branch 'pr/999'
|
||||
```
|
||||
|
||||
To get latest changes to the PR:
|
||||
|
||||
```
|
||||
$ git checkout pr/1000
|
||||
$ git pull --tags origin refs/pull/1000/head
|
||||
From https://github.com/microsoft/angular-react
|
||||
* branch refs/pull/1000/head -> FETCH_HEAD
|
||||
Updating aab92e2..2896b73
|
||||
Fast-forward
|
||||
...
|
||||
```
|
||||
|
||||
Note: "git pull" did not work for me by itself for the PR branch... Perhaps "git pull origin".
|
||||
[fab-c]: https://developer.microsoft.com/en-us/fabric#/components
|
||||
[lib-core]: https://www.npmjs.com/package/@angular-react/core
|
||||
[lib-fab]: https://www.npmjs.com/package/@angular-react/fabric
|
||||
|
|
@ -37,8 +37,33 @@ High level stuff planned for Q2 2018 (April - June):
|
|||
|
||||
| Feature | Notes | Docs |
|
||||
|------------------|--------------------------------------------------------|--------------|
|
||||
| button | More features coming in 2018 | [Docs][0] |
|
||||
| dialog | More features coming in 2018 | [Docs][1] |
|
||||
| breadcrumb | Beta | [Docs][0] |
|
||||
| button | Beta | [Docs][0] |
|
||||
| callout | Beta | [Docs][0] |
|
||||
| choice-group | Beta | [Docs][0] |
|
||||
| combo-box | Beta | [Docs][0] |
|
||||
| command-bar | Heavily tested, most scenarios covered. | [Docs][0] |
|
||||
| contextual-menu | Beta | [Docs][0] |
|
||||
| date-picker | Beta | [Docs][0] |
|
||||
| dialog | Beta | [Docs][1] |
|
||||
| divider | Beta | [Docs][0] |
|
||||
| grouped-list | Beta | [Docs][0] |
|
||||
| hover-card | Beta | [Docs][0] |
|
||||
| icon | Beta | [Docs][0] |
|
||||
| image | Beta | [Docs][0] |
|
||||
| link | Beta | [Docs][0] |
|
||||
| message-bar | Beta | [Docs][0] |
|
||||
| modal | Beta | [Docs][0] |
|
||||
| panel | Beta | [Docs][0] |
|
||||
| persona | Beta | [Docs][0] |
|
||||
| pickers | Beta | [Docs][0] |
|
||||
| pivot | Beta | [Docs][0] |
|
||||
| search-box | Beta | [Docs][0] |
|
||||
| shimmer | Beta | [Docs][0] |
|
||||
| slider | Beta | [Docs][0] |
|
||||
| spinner | Beta | [Docs][0] |
|
||||
| toggle | Beta | [Docs][0] |
|
||||
| tooltip | Beta | [Docs][0] |
|
||||
|
||||
#### In progress, planned, and non-planned Fabric features
|
||||
|
||||
|
|
|
|||
|
|
@ -6322,14 +6322,12 @@
|
|||
"balanced-match": {
|
||||
"version": "1.0.0",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"brace-expansion": {
|
||||
"version": "1.1.11",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"balanced-match": "^1.0.0",
|
||||
"concat-map": "0.0.1"
|
||||
|
|
@ -6344,20 +6342,17 @@
|
|||
"code-point-at": {
|
||||
"version": "1.1.0",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"concat-map": {
|
||||
"version": "0.0.1",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"console-control-strings": {
|
||||
"version": "1.1.0",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"core-util-is": {
|
||||
"version": "1.0.2",
|
||||
|
|
@ -6474,8 +6469,7 @@
|
|||
"inherits": {
|
||||
"version": "2.0.3",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"ini": {
|
||||
"version": "1.3.5",
|
||||
|
|
@ -6487,7 +6481,6 @@
|
|||
"version": "1.0.0",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"number-is-nan": "^1.0.0"
|
||||
}
|
||||
|
|
@ -6502,7 +6495,6 @@
|
|||
"version": "3.0.4",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"brace-expansion": "^1.1.7"
|
||||
}
|
||||
|
|
@ -6510,14 +6502,12 @@
|
|||
"minimist": {
|
||||
"version": "0.0.8",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"minipass": {
|
||||
"version": "2.2.4",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"safe-buffer": "^5.1.1",
|
||||
"yallist": "^3.0.0"
|
||||
|
|
@ -6536,7 +6526,6 @@
|
|||
"version": "0.5.1",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"minimist": "0.0.8"
|
||||
}
|
||||
|
|
@ -6617,8 +6606,7 @@
|
|||
"number-is-nan": {
|
||||
"version": "1.0.1",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true
|
||||
"dev": true
|
||||
},
|
||||
"object-assign": {
|
||||
"version": "4.1.1",
|
||||
|
|
@ -6630,7 +6618,6 @@
|
|||
"version": "1.4.0",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"wrappy": "1"
|
||||
}
|
||||
|
|
@ -6752,7 +6739,6 @@
|
|||
"version": "1.0.2",
|
||||
"bundled": true,
|
||||
"dev": true,
|
||||
"optional": true,
|
||||
"requires": {
|
||||
"code-point-at": "^1.0.0",
|
||||
"is-fullwidth-code-point": "^1.0.0",
|
||||
|
|
|
|||
Загрузка…
Ссылка в новой задаче