diff --git a/docs/README.md b/docs/README.md index cf5704d713..34329769d7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -163,8 +163,8 @@ for more information about installing and using the source code. | Name | Description | Source link | | ---- | ----------- | ----------- | -| [Data Table Adapter interface](DataTableAdapter.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | -| [Form Field Validator interface](FormFieldValidator.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | +| [Data Table Adapter interface](datatable-adapter.interface.md) | Defines how table data is supplied to [DataTable](datatable.component.md) and [Tasklist](task-list.component.md) components. | [Source](../lib/core/datatable/data/datatable-adapter.ts) | +| [Form Field Validator interface](form-field-validator.interface.md) | Defines how the input fields of [ADF Form](form.component.md) and [ADF Task Details](task-details.component.md) components are validated. | [Source](../lib/core/form/components/widgets/core/form-field-validator.ts) | | [Search Configuration interface](search-configuration.interface.md) | Provides fine control of parameters to a search. | [Source](../lib/core/services/search-configuration.service.ts) | [(Back to Contents)](#contents) diff --git a/docs/data-column.component.md b/docs/data-column.component.md index 9238db499a..529e53a7d2 100644 --- a/docs/data-column.component.md +++ b/docs/data-column.component.md @@ -105,9 +105,9 @@ Every cell in the DataTable component is bound to the dynamic data context conta | Name | Type | Description | | ---- | ---- | ----------- | -| data | [DataTableAdapter](DataTableAdapter.md) | Data adapter instance. | -| row | [DataRow](DataTableAdapter.md) | Current data row instance. | -| col | [DataColumn](DataTableAdapter.md) | Current data column instance. | +| data | [DataTableAdapter](datatable-adapter.interface.md) | Data adapter instance. | +| row | [DataRow](datatable-adapter.interface.md) | Current data row instance. | +| col | [DataColumn](datatable-adapter.interface.md) | Current data column instance. | You can use all three properties to gain full access to underlying data from within your custom templates. In order to wire HTML templates with the data context you will need defining a variable that is bound to `$implicit` like shown below: diff --git a/docs/DataTableAdapter.md b/docs/datatable-adapter.interface.md similarity index 100% rename from docs/DataTableAdapter.md rename to docs/datatable-adapter.interface.md diff --git a/docs/datatable.component.md b/docs/datatable.component.md index bda049d670..7eee0feb6c 100644 --- a/docs/datatable.component.md +++ b/docs/datatable.component.md @@ -159,7 +159,7 @@ The column layout and row data are supplied to the table using an object that im DataTableAdapter interface. This interface hides the internal details of the class that provides the data, which gives a lot of flexibility in how the data can be stored and accessed. The DataTable library includes a standard adapter class called ObjectDataTableAdapter that is useful for many -common uses. See the [DataTableAdapter](DataTableAdapter.md) for full details about the interface and +common uses. See the [DataTableAdapter](datatable-adapter.interface.md) for full details about the interface and the ObjectDataTableAdapter class. ### Customizing columns @@ -482,6 +482,6 @@ and do corresponding actions. - [Data column component](data-column.component.md) - [Pagination component](pagination.component.md) -- [DataTableAdapter](DataTableAdapter.md) +- [DataTableAdapter](datatable-adapter.interface.md) - [Document list component](document-list.component.md) diff --git a/docs/FormFieldValidator.md b/docs/form-field-validator.interface.md similarity index 100% rename from docs/FormFieldValidator.md rename to docs/form-field-validator.interface.md diff --git a/docs/form-field.model.md b/docs/form-field.model.md index fb2128bfc2..d3ca1fbb11 100644 --- a/docs/form-field.model.md +++ b/docs/form-field.model.md @@ -47,7 +47,7 @@ Contains the value and metadata for a field of an [ADF Form](form.component.md). | fields | FormFieldModel\[] | \[] | Fields contained within a container field | | columns | ContainerColumnModel\[] | \[] | Column definitions for a container field | | emptyOption | FormFieldOption | | Dropdown menu item to use when no option is chosen | -| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](FormFieldValidator.md) interface) | +| validationSummary | string | | Error/information message added during field validation (see [FormFieldValidator](form-field-validator.interface.md) interface) | ## Details @@ -70,7 +70,7 @@ check to a field. A number of `FormFieldModel` properties are used by validators example, `minValue` and `maxValue` are used to check that a numeric value falls within an allowed range and `regexPattern` defines a regular expression that a text field should match. Also, the `validationSummary` is used to send a message back from the validator -for the user to read. See the [FormFieldValidator](FormFieldValidator.md) page for more information about implementing validators. +for the user to read. See the [FormFieldValidator](form-field-validator.interface.md) page for more information about implementing validators. ### REST properties @@ -94,6 +94,6 @@ contains full details about how the REST calls work, along with a worked example ## See also - [Extensibility](extensibility.md) -- [FormFieldValidator](FormFieldValidator.md) +- [FormFieldValidator](form-field-validator.interface.md) - [Form rendering service](form-rendering.service.md) - [Form component](form.component.md) diff --git a/docs/form.component.md b/docs/form.component.md index 8c9161fc5b..f10022f069 100644 --- a/docs/form.component.md +++ b/docs/form.component.md @@ -11,7 +11,6 @@ Shows a Form from APS (see it live: [Form Quickstart](https://embed.plnkr.co/YSL - [Basic Usage](#basic-usage) - [Properties](#properties) - - [Advanced properties](#advanced-properties) - [Events](#events) - [Details](#details) @@ -233,7 +232,7 @@ property. Each validator implements checks for a particular type of data (eg, a date validator might check that the date in the field falls between 1980 and 2017). ADF supplies a standard set of validators that handle most common cases but you can also implement your own custom validators to replace or extend the set. See the -[FormFieldValidator](FormFieldValidator.md) class for full details and examples. +[FormFieldValidator](form-field-validator.interface.md) class for full details and examples. ## Other documentation @@ -310,7 +309,7 @@ Using the CSS you can target any outcome ID and change the style as in this exam ## See also - [Stencils](stencils.md) -- [FormFieldValidator](FormFieldValidator.md) +- [FormFieldValidator](form-field-validator.interface.md) - [Extensibility](extensibility.md) - [Form rendering service](form-rendering.service.md) - [Form field model](form-field.model.md) diff --git a/docs/people.component.md b/docs/people.component.md index 9ed1a5c1ae..9f757e2268 100644 --- a/docs/people.component.md +++ b/docs/people.component.md @@ -11,7 +11,6 @@ Displays users involved with a specified task - [Basic Usage](#basic-usage) - [Properties](#properties) - - [Events](#events) - [Details](#details) diff --git a/docs/process-list.component.md b/docs/process-list.component.md index 2a372ad3d4..4ac2114218 100644 --- a/docs/process-list.component.md +++ b/docs/process-list.component.md @@ -142,5 +142,5 @@ Example value for the schemaColumn property (see [Properties](#properties) secti ## See also - [Data column component](data-column.component.md) -- [DataTableAdapter](DataTableAdapter.md) +- [DataTableAdapter](datatable-adapter.interface.md) - [Pagination component](pagination.component.md) \ No newline at end of file diff --git a/docs/task-list.component.md b/docs/task-list.component.md index 88733b6c4d..11586ac4b3 100644 --- a/docs/task-list.component.md +++ b/docs/task-list.component.md @@ -165,7 +165,7 @@ adf-tasklist also supports pagination and the same can be used as shown below. | hasIcon | boolean | true | Toggle the icon on the left . | | landingTaskId | string | | Define which task id should be selected after the reloading. If the task id doesn't exist or nothing is passed it will select the first task | | sort | string | | Define the sort of the processes. Possible values are : `created-desc`, `created-asc`, `due-desc`, `due-asc` | -| data | [DataTableAdapter](DataTableAdapter.md) | | JSON object that represent the number and the type of the columns that you want show (see the [example](#datatableadapter-example) section below) | +| data | [DataTableAdapter](datatable-adapter.interface.md) | | JSON object that represent the number and the type of the columns that you want show (see the [example](#datatableadapter-example) section below) | ### Events @@ -182,7 +182,7 @@ render details of any chosen instance. ### DataTableAdapter example -See the [DataTableAdapter](DataTableAdapter.md) page for full details of the interface and its standard +See the [DataTableAdapter](datatable-adapter.interface.md) page for full details of the interface and its standard implementation, ObjectDataTableAdapter. Below is an example of how you can set up the adapter for a typical tasklist. @@ -202,5 +202,5 @@ You can customize the styling of a column and also add features like tooltips an ## See also - [Data column component](data-column.component.md) -- [DataTableAdapter](DataTableAdapter.md) +- [DataTableAdapter](datatable-adapter.interface.md) - [Pagination component](pagination.component.md) diff --git a/docs/viewer.component.md b/docs/viewer.component.md index 3c0126e1cf..15e6797851 100644 --- a/docs/viewer.component.md +++ b/docs/viewer.component.md @@ -19,7 +19,7 @@ See it live: [Viewer Quickstart](https://embed.plnkr.co/iTuG1lFIXfsP95l6bDW6/) - [Integrating with DocumentList component](#integrating-with-documentlist-component) - [Supported file formats](#supported-file-formats) - - [PDF Conversion](#pdf-conversion) + - [Content renditions](#content-renditions) - [Configuring PDF.js library](#configuring-pdfjs-library) - [Custom toolbar](#custom-toolbar) - [Custom sidebar](#custom-sidebar)