mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-31 17:38:48 +00:00
121 lines
2.6 KiB
Markdown
121 lines
2.6 KiB
Markdown
# Alfresco Social Component
|
|
|
|
<!-- markdown-toc start - Don't edit this section. npm run toc to generate it-->
|
|
|
|
<!-- toc -->
|
|
|
|
- [Prerequisites](#prerequisites)
|
|
- [Install](#install)
|
|
- [Basic usage](#basic-usage)
|
|
- [adf-like](#adf-like)
|
|
* [Properties](#properties)
|
|
* [Events](#events)
|
|
- [adf-rating](#adf-rating)
|
|
* [Properties](#properties-1)
|
|
* [Events](#events-1)
|
|
- [Build from sources](#build-from-sources)
|
|
- [NPM scripts](#npm-scripts)
|
|
- [Demo](#demo)
|
|
- [License](#license)
|
|
|
|
<!-- tocstop -->
|
|
|
|
<!-- markdown-toc end -->
|
|
|
|
## 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
|
|
|
|
```sh
|
|
npm install ng2-alfresco-social
|
|
```
|
|
|
|
## Basic usage
|
|
|
|
In this component there are two different components:
|
|
|
|
* adf-like
|
|
* adf-rating
|
|
|
|
## adf-like
|
|
|
|
```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
|
|
|
|
```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 |
|
|
|
|
|
|
|
|
## Build from sources
|
|
|
|
You can build component from sources with the following commands:
|
|
|
|
```sh
|
|
npm install
|
|
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
|
|
|
|
| Command | Description |
|
|
| --- | --- |
|
|
| npm run build | Build component |
|
|
| npm run test | Run unit tests in the console |
|
|
| npm run test-browser | Run unit tests in the browser
|
|
| npm run coverage | Run unit tests and display code coverage report |
|
|
|
|
## Demo
|
|
|
|
Please check the demo folder for a demo project
|
|
|
|
```sh
|
|
cd demo
|
|
npm install
|
|
npm start
|
|
```
|
|
|
|
## License
|
|
|
|
[Apache Version 2.0](https://github.com/Alfresco/alfresco-ng2-components/blob/master/LICENSE)
|