inteligr8/alfresco-ng2-components
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-ng2-components.git synced 2025-07-31 17:38:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

add style to the doc

Browse Source
This commit is contained in:
Mario Romano
2016-06-01 12:21:36 +01:00
parent c056bd075b
commit a6d3c99904
5 changed files with 94 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
ng2-components/ng2-alfresco-documentlist/README.md
View File

@@ -468,6 +468,22 @@ export class MyView {
Typically you may want populating all your custom actions at the application root level or
by means of custom application service.
#### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material
design dependency to your project:
```sh
npm install --save material-design-icons material-design-lite
```
Also make sure you include these dependencies in your .html page:
```html
<!-- Google Material Design Lite -->
<link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
<script src="node_modules/material-design-lite/material.min.js"></script>
<link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
```
## Build from sources

3
ng2-components/ng2-alfresco-documentlist/demo/package.json
View File

@@ -24,9 +24,6 @@
"material-design-icons": "^2.2.3",
"material-design-lite": "^1.1.3",
"zone.js": "0.6.10",
"ng2-translate": "^1.11.3",
"alfresco-core-rest-api": "^0.1.0",
"ng2-alfresco-core": "^0.1.0",
"ng2-alfresco-documentlist": "^0.1.0"
},
"devDependencies": {

36
ng2-components/ng2-alfresco-login/README.md
View File

@@ -16,16 +16,6 @@ npm set registry http://devproducts.alfresco.me:4873
npm install --save ng2-alfresco-login
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
Components included:
* Alfresco Login Component
@@ -142,6 +132,32 @@ bootstrap(AppComponent, [
**method**: {string} optional) default POST. The method attribute specifies how to send form-data
The form-data can be sent as URL variables (with method="get") or as HTTP post transaction (with method="post").<br />
#### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material
design dependency to your project:
```sh
npm install --save material-design-icons material-design-lite
```
Also make sure you include these dependencies in your .html page:
```html
<!-- Google Material Design Lite -->
<link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
<script src="node_modules/material-design-lite/material.min.js"></script>
<link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
## Running unit tests
```sh

36
ng2-components/ng2-alfresco-upload/README.md
View File

@@ -16,16 +16,6 @@ npm set registry http://devproducts.alfresco.me:4873
npm install --save ng2-alfresco-upload
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
Components included:
- [Upload button](#upload-button)
@@ -191,6 +181,32 @@ bootstrap(MyDemoApp, [
**showDialogUpload**: {boolean} optional) default true. Hide/show upload dialog.<br />
#### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material
design dependency to your project:
```sh
npm install --save material-design-icons material-design-lite
```
Also make sure you include these dependencies in your .html page:
```html
<!-- Google Material Design Lite -->
<link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
<script src="node_modules/material-design-lite/material.min.js"></script>
<link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
## Running unit tests
```sh

35
ng2-components/ng2-alfresco-viewer/README.md
View File

@@ -16,15 +16,6 @@ npm set registry http://devproducts.alfresco.me:4873
npm install --save ng2-alfresco-viewer
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
#### Dependencies
Add the following dependency to your index.html:
@@ -104,6 +95,32 @@ Method | Parameters | Returns | Description
--- | --- | --- | ---
`methodName()` | None. | void | Lorem ipsum dolor.
#### Style
The style of this component is based on material design, so if you want to visualize it correctly you have to add the material
design dependency to your project:
```sh
npm install --save material-design-icons material-design-lite
```
Also make sure you include these dependencies in your .html page:
```html
<!-- Google Material Design Lite -->
<link rel="stylesheet" href="node_modules/material-design-lite/material.min.css">
<script src="node_modules/material-design-lite/material.min.js"></script>
<link rel="stylesheet" href="node_modules/material-design-icons/iconfont/material-icons.css">
```
## Build from sources
Alternatively you can build component from sources with the following commands:
```sh
npm install
npm run build
```
## Running unit tests
```sh