mirror of
https://github.com/Alfresco/alfresco-ng2-components.git
synced 2025-07-24 17:32:15 +00:00
[ADF-4249] Updates for doc review (#4470)
* [ADF-4249] Updated review checker tool to work with new doc subfolders * [ADF-4249] Updates for doc review
This commit is contained in:
Andy Stark
committed by
Eugenio Romano
Eugenio Romano
parent
10e91bed2a
commit
e5c7ffb314
@@ -2,7 +2,7 @@
|
||||
Title: Content Node Selector Panel component
|
||||
Added: v2.1.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-01-16
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Content Node Selector Panel component](../../../lib/content-services/content-node-selector/content-node-selector-panel.component.ts "Defined in content-node-selector-panel.component.ts")
|
||||
@@ -33,7 +33,7 @@ Opens a [Content Node Selector](content-node-selector.component.md) in its own
|
||||
| breadcrumbTransform | `Function` | | Transformation to be performed on the chosen/folder node before building the breadcrumb UI. Can be useful when custom formatting is needed for the breadcrumb. You can change the path elements from the node that are used to build the breadcrumb using this function. |
|
||||
| currentFolderId | `string` | null | [Node](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) ID of the folder currently listed. |
|
||||
| dropdownHideMyFiles | `boolean` | false | Hide the "My Files" option added to the site list by default. See the [Sites Dropdown component](sites-dropdown.component.md) for more information. |
|
||||
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList`. property of the Sites Dropdown component (see its doc page for more information). |
|
||||
| dropdownSiteList | [`SitePaging`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/SitePaging.md) | null | Custom site for site dropdown. This is the same as the `siteList` property of the Sites Dropdown component (see its doc page for more information). |
|
||||
| imageResolver | `ImageResolver` | null | Custom image resolver function. See the [Image Resolver Model](../models/image-resolver.model.md) page for more information. |
|
||||
| isSelectionValid | `ValidationFunction` | defaultValidation | Function used to decide if the selected node has permission to be selected. Default value is a function that always returns true. |
|
||||
| pageSize | `number` | | Number of items shown per page in the list. |
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Document List component
|
||||
Added: v2.0.0
|
||||
Status: Active
|
||||
Last reviewed: 2019-02-08
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Document List component](../../../lib/content-services/document-list/components/document-list.component.ts "Defined in document-list.component.ts")
|
||||
@@ -477,28 +477,10 @@ documentation for a full explanation of the component lifecycle.
|
||||
### Underlying node object
|
||||
|
||||
The [Document List component](document-list.component.md) assigns an instance of
|
||||
[`MinimalNode`](https://github.com/Alfresco/alfresco-js-api/blob/master/src/alfresco-core-rest-api/docs/NodeMinimalEntry.md)
|
||||
the [`Node`](https://github.com/Alfresco/alfresco-js-api/blob/development/src/api/content-rest-api/docs/Node.md) class
|
||||
(defined in the [Alfresco JS API](https://github.com/Alfresco/alfresco-js-api)) as the data context
|
||||
for each row. You can make use of the properties of this object when defining custom columns:
|
||||
|
||||
```js
|
||||
export interface MinimalNode {
|
||||
id: string;
|
||||
parentId: string;
|
||||
name: string;
|
||||
nodeType: string;
|
||||
isFolder: boolean;
|
||||
isFile: boolean;
|
||||
modifiedAt: Date;
|
||||
modifiedByUser: UserInfo;
|
||||
createdAt: Date;
|
||||
createdByUser: UserInfo;
|
||||
content: ContentInfo;
|
||||
path: PathInfoEntity;
|
||||
properties: NodeProperties;
|
||||
}
|
||||
```
|
||||
|
||||
Binding to nested properties is also supported. You can define a column key as a property path similar to the following:
|
||||
|
||||
```text
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
Title: Search Filter component
|
||||
Added: v2.3.0
|
||||
Status: Active
|
||||
Last reviewed: 2018-06-12
|
||||
Last reviewed: 2019-03-20
|
||||
---
|
||||
|
||||
# [Search Filter component](../../../lib/content-services/search/components/search-filter/search-filter.component.ts "Defined in search-filter.component.ts")
|
||||
@@ -19,7 +19,7 @@ Represents a main container component for custom search and faceted search setti
|
||||
- [Categories and widgets](#categories-and-widgets)
|
||||
- [Facet Fields](#facet-fields)
|
||||
- [Facet Queries](#facet-queries)
|
||||
- [highlight](#highlight)
|
||||
- [Highlight](#highlight)
|
||||
- [Facet Intervals](#facet-intervals)
|
||||
- [See also](#see-also)
|
||||
|
||||
@@ -372,7 +372,9 @@ The default page size of 5 will be used if you set the value to 0 or omit it ent
|
||||
|
||||
### Facet Intervals
|
||||
|
||||
These provide custom categories based on admin defined ranges inside `intervals`. What is wanted for every interval can be specified exactly in the config file, and having overlapping ranges could also be possible.
|
||||
These provide custom categories based on admin defined ranges inside `intervals`.
|
||||
You can specify exactly what you want for each interval in the config file and you can
|
||||
use overlapping ranges if necessary.
|
||||
|
||||
#### FacetIntervals Properties
|
||||
|
||||
@@ -381,7 +383,8 @@ These provide custom categories based on admin defined ranges inside `intervals`
|
||||
| intervals | array | Specifies the fields to facet by interval. |
|
||||
| expanded | boolean | Toggles expanded state of the facet intervals. |
|
||||
|
||||
Note: `sets` parameter from Search API (Sets the intervals for all fields) is not yet supported.
|
||||
Note: the `sets` parameter from the Search API (which sets the intervals for all fields)
|
||||
is not yet supported.
|
||||
|
||||
```json
|
||||
{
|
||||
@@ -414,16 +417,17 @@ Note: `sets` parameter from Search API (Sets the intervals for all fields) is no
|
||||
```
|
||||
|
||||
You can specify a value for the `mincount` property inside each `intervals` item to set the minimum count required for a facet interval to be displayed. By default, only the intervals that have 1 or more response entries are displayed at runtime.
|
||||
Check the [schema.json](https://github.com/Alfresco/alfresco-ng2-components/blob/master/lib/core/app-config/schema.json)
|
||||
for more details about what is the structure and the properties of `intervals` that you can set inside the configuration file.
|
||||
Check the [schema.json](https://github.com/Alfresco/alfresco-ng2-components/blob/master/lib/core/app-config/schema.json) file
|
||||
for further details about the structure and properties of `intervals` that you can set inside the configuration file.
|
||||
|
||||
Each `intervals` item defined is collected into its collapsible category identified uniquely by its `label`. The top code snippet will result in the following display of the facet intervals:
|
||||
Each defined `intervals` item is collected into its own collapsible category identified uniquely
|
||||
by its `label`. The code snippet just above will result in the following display of facet intervals:
|
||||
|
||||
|
||||
|
||||
### Highlight
|
||||
|
||||
You can configure the Highlight using the `search` entry in the `app.config.json` file.
|
||||
You can configure highlighting using the `search` entry in the `app.config.json` file.
|
||||
An example query for search highlighting could look like this:
|
||||
|
||||
```json
|
||||
@@ -450,29 +454,31 @@ An example query for search highlighting could look like this:
|
||||
|
||||
```
|
||||
|
||||
The example above changes the highlighting prefix and postfix from the default for all fields to ¿? and just for the "description" field to (). The highlight information will then be added in each node entry response; here is an example partial response:
|
||||
The example above changes the highlighting prefix and postfix from the default to '¿?' for all
|
||||
fields except the "description" field, which uses '()' instead. The highlight information will
|
||||
then be added in each node entry response. An example partial response is shown below:
|
||||
|
||||
```json
|
||||
"entry": {
|
||||
"createdAt": "2016-10-12T15:24:31.202+0000",
|
||||
"isFolder": true,
|
||||
"search": {
|
||||
"score": 1,
|
||||
"highlight": [
|
||||
{
|
||||
"field": "cm:title",
|
||||
"snippets": [
|
||||
"createdAt": "2016-10-12T15:24:31.202+0000",
|
||||
"isFolder": true,
|
||||
"search": {
|
||||
"score": 1,
|
||||
"highlight": [
|
||||
{
|
||||
"field": "cm:title",
|
||||
"snippets": [
|
||||
"Customized ¿Workflow? Process Definitions"
|
||||
]
|
||||
},
|
||||
{
|
||||
"field": "description",
|
||||
"snippets": [
|
||||
]
|
||||
},
|
||||
{
|
||||
"field": "description",
|
||||
"snippets": [
|
||||
"Customized (Workflow) Process Definitions"
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
]
|
||||
}
|
||||
]
|
||||
},
|
||||
```
|
||||
## See also
|
||||
|
||||
|
||||
Reference in New Issue
Block a user