[ADF-1549] Removed doc content from library README files (#2400)

* [ADF-1549] Removed doc content from library README files

* [ADF-1549] Removed doc content from library README files

* [ADF-1583] Fix change detection error (the quick way) (#2396)

* Fix change detection error (the quick way)

* Fix it the second time

* raise keyboard events, improve task list keyboard handling (#2401)

* [ADF-1549] Removed doc content from library README files

* [ADF-1549] Added doc update from Tasklist readme
This commit is contained in:
Andy Stark
2017-10-02 22:41:44 +01:00
committed by Eugenio Romano
parent 79422ac32c
commit e8235fa7fe
99 changed files with 313 additions and 6345 deletions

View File

@@ -6,88 +6,37 @@ Contains the ADF Like and ADF Rating components.
<!-- toc -->
- [ADF Like component](#adf-like-component)
* [Basic Usage](#basic-usage)
+ [Properties](#properties)
+ [Events](#events)
- [ADF Rating component](#adf-rating-component)
* [Basic Usage](#basic-usage-1)
+ [Properties](#properties-1)
+ [Events](#events-1)
- [Project Information](#project-information)
* [Prerequisites](#prerequisites)
* [Install](#install)
* [Build from sources](#build-from-sources)
* [NPM scripts](#npm-scripts)
* [Demo](#demo)
* [License](#license)
- [Documentation](#documentation)
- [Prerequisites](#prerequisites)
- [Install](#install)
- [Build from sources](#build-from-sources)
- [NPM scripts](#npm-scripts)
- [Demo](#demo)
- [License](#license)
<!-- tocstop -->
<!-- markdown-toc end -->
## ADF Like component
## Documentation
![Custom columns](docs/assets/social1.png)
See the [ADF Social](../../docIndex.md#adf-social) section of the [docs index](../../docIndex.md)
for all available documentation on this library.
### Basic Usage
```html
<adf-like [nodeId]="nodeId"></adf-like>
```
#### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| nodeId | string | | The identifier of a node.|
#### Events
| Name | Description |
| --- | --- |
| changeVote | Raised when vote gets changed |
## ADF Rating component
![Custom columns](docs/assets/social2.png)
### Basic Usage
```html
<adf-rating
[nodeId]="'74cd8a96-8a21-47e5-9b3b-a1b3e296787d'">
</adf-rating>
```
#### Properties
| Attribute | Type | Default | Description |
| --- | --- | --- | --- |
| nodeId | string | | The identifier of a node |
#### Events
| Name | Description |
| --- | --- |
| changeVote | Raised when vote gets changed |
## Project Information
### Prerequisites
## Prerequisites
Before you start using this development framework, make sure you have installed all required software and done all the
necessary configuration [prerequisites](https://github.com/Alfresco/alfresco-ng2-components/blob/master/PREREQUISITES.md).
> If you plan using this component with projects generated by Angular CLI, please refer to the following article: [Using ADF with Angular CLI](https://github.com/Alfresco/alfresco-ng2-components/wiki/Angular-CLI)
### Install
## Install
```sh
npm install ng2-alfresco-social
```
### Build from sources
## Build from sources
You can build component from sources with the following commands:
@@ -99,7 +48,7 @@ npm run build
> The `build` task rebuilds all the code, runs tslint, license checks
> and other quality check tools before performing unit testing.
### NPM scripts
## NPM scripts
| Command | Description |
| --- | --- |
@@ -108,7 +57,7 @@ npm run build
| npm run test-browser | Run unit tests in the browser
| npm run coverage | Run unit tests and display code coverage report |
### Demo
## Demo
Please check the demo folder for a demo project
@@ -118,6 +67,6 @@ npm install
npm start
```
### License
## License
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)