basic toolbar docs and screenshots (#2108)
@ -44,6 +44,7 @@ adf-document-list >>> adf-datatable tr.is-selected .image-table-cell::before {
|
||||
|
||||
.adf-demo-site-container-style {
|
||||
margin-top: 10px;
|
||||
margin-bottom: 10px;
|
||||
margin-left: 3%;
|
||||
width: 100%;
|
||||
min-width: 200px;
|
||||
|
@ -6,8 +6,6 @@
|
||||
|
||||
- [Prerequisites](#prerequisites)
|
||||
- [Install](#install)
|
||||
- [Toolbar Component](#toolbar-component)
|
||||
* [Properties](#properties)
|
||||
- [Upload Directive](#upload-directive)
|
||||
* [Basic usage](#basic-usage)
|
||||
* [Modes](#modes)
|
||||
@ -65,25 +63,11 @@ necessary configuration, see this [page](https://github.com/Alfresco/alfresco-ng
|
||||
npm install ng2-alfresco-core
|
||||
```
|
||||
|
||||
## Toolbar Component
|
||||
Available features
|
||||
|
||||
```html
|
||||
<adf-toolbar title="Toolbar">
|
||||
<button md-icon-button>
|
||||
<md-icon>create_new_folder</md-icon>
|
||||
</button>
|
||||
<button md-icon-button>
|
||||
<md-icon>delete</md-icon>
|
||||
</button>
|
||||
</adf-toolbar>
|
||||
```
|
||||
|
||||
### Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| title | string | | Toolbar title |
|
||||
| color | string | | Toolbar color, can be changed to empty value (default), `primary`, `accent` or `warn`. |
|
||||
| Feature | Notes | Docs |
|
||||
| --- | --- | --- |
|
||||
| toolbar | --- | [Docs](src/components/toolbar/toolbar.md) |
|
||||
|
||||
## Upload Directive
|
||||
|
||||
|
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 36 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 32 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 14 KiB |
After Width: | Height: | Size: 14 KiB |
@ -0,0 +1,92 @@
|
||||
# Toolbar Component
|
||||
|
||||
## Basic example
|
||||
|
||||
```html
|
||||
<adf-toolbar title="Toolbar">
|
||||
<button md-icon-button>
|
||||
<md-icon>create_new_folder</md-icon>
|
||||
</button>
|
||||
<button md-icon-button>
|
||||
<md-icon>delete</md-icon>
|
||||
</button>
|
||||
</adf-toolbar>
|
||||
```
|
||||
|
||||
You should see result similar to the following one:
|
||||
|
||||

|
||||
|
||||
## Properties
|
||||
|
||||
| Name | Type | Default | Description |
|
||||
| --- | --- | --- | --- |
|
||||
| title | string | | Toolbar title |
|
||||
| color | string | | Toolbar color, can be changed to empty value (default), `primary`, `accent` or `warn`. |
|
||||
|
||||
## Custom title
|
||||
|
||||
You can use any HTML layout or Angular component as a content of the Title section by using the special `<adf-toolbar-title>` component instead of the "title" attribute:
|
||||
|
||||
```html
|
||||
<adf-toolbar>
|
||||
<adf-toolbar-title>
|
||||
<adf-breadcrumb ...></adf-breadcrumb>
|
||||
</adf-toolbar-title>
|
||||
...
|
||||
</adf-toolbar>
|
||||
```
|
||||
|
||||
The toolbar should now look similar to the following:
|
||||
|
||||

|
||||
|
||||
## Dropdown menu
|
||||
|
||||
You can use the following example to create a dropdown menu:
|
||||
|
||||
```html
|
||||
<adf-toolbar title="Toolbar">
|
||||
...
|
||||
|
||||
<button md-icon-button [mdMenuTriggerFor]="menu">
|
||||
<md-icon>more_vert</md-icon>
|
||||
</button>
|
||||
<md-menu #menu="mdMenu">
|
||||
<button md-menu-item>
|
||||
<md-icon>dialpad</md-icon>
|
||||
<span>Redial</span>
|
||||
</button>
|
||||
<button md-menu-item disabled>
|
||||
<md-icon>voicemail</md-icon>
|
||||
<span>Check voicemail</span>
|
||||
</button>
|
||||
<button md-menu-item>
|
||||
<md-icon>notifications_off</md-icon>
|
||||
<span>Disable alerts</span>
|
||||
</button>
|
||||
</md-menu>
|
||||
</adf-toolbar>
|
||||
```
|
||||
|
||||
The code above is based on the `<md-menu>` component from the `@angular/material` library. You can use any custom menu component as well.
|
||||
|
||||

|
||||
|
||||
Once you click the menu button you should see the following menu items as defined earlier:
|
||||
|
||||

|
||||
|
||||
## Custom color
|
||||
|
||||
Besides the default color you can use 'primary', 'accent', or 'warn' values:
|
||||
|
||||
Depending on the overall application theme the colors of the toolbar should change.
|
||||
|
||||
For example:
|
||||
|
||||

|
||||
|
||||

|
||||
|
||||

|