Skip to content

New input filter-builder-function #735

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
patricia-martinez-imatia merged 1 commit into from
Mar 16, 2026
Merged

New input filter-builder-function #735

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _data/components/grid.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ inheritedAttributes: [{
},{
component: "OServiceComponent",
path: "components/service/service/api",
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "quick-filter", "quick-filter-placeholder", "quick-filter-appearance", "pagination-controls", "page-size-options","initial-filter-function"]
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "quick-filter", "quick-filter-placeholder", "quick-filter-appearance", "pagination-controls", "page-size-options","initial-filter-function", "filter-builder-function"]
}]

attributes: [{
Expand Down
2 changes: 1 addition & 1 deletion _data/components/list.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ inheritedAttributes: [{
},{
component: "OServiceComponent",
path: "components/service/service/api",
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "detail-button-in-row", "detail-button-in-row-icon", "edit-form-route", "recursive-edit", "edit-button-in-row", "edit-button-in-row-icon", "insert-button", "row-height", "insert-form-route", "recursive-insert", "quick-filter", "quick-filter-placeholder", "quick-filter-appearance", "pagination-controls", "page-size-options","initial-filter-function"]
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "detail-button-in-row", "detail-button-in-row-icon", "edit-form-route", "recursive-edit", "edit-button-in-row", "edit-button-in-row-icon", "insert-button", "row-height", "insert-form-route", "recursive-insert", "quick-filter", "quick-filter-placeholder", "quick-filter-appearance", "pagination-controls", "page-size-options","initial-filter-function", "filter-builder-function"]
}]

inheritedOutputs: [{
Expand Down
2 changes: 1 addition & 1 deletion _data/components/otableData/00table.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ inheritedAttributes: [{
},{
component: "OServiceComponent",
path: "components/service/service/api",
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "detail-button-in-row", "detail-button-in-row-icon", "edit-form-route", "recursive-edit", "edit-button-in-row", "edit-button-in-row-icon", "insert-button", "row-height", "insert-form-route", "recursive-insert", "filter-case-sensitive", "quick-filter", "quick-filter-placeholder", "pagination-controls", "page-size-options","initial-filter-function"]
attributes: ["title", "visible", "enabled", "controls", "detail-mode", "detail-form-route", "recursive-detail", "detail-button-in-row", "detail-button-in-row-icon", "edit-form-route", "recursive-edit", "edit-button-in-row", "edit-button-in-row-icon", "insert-button", "row-height", "insert-form-route", "recursive-insert", "filter-case-sensitive", "quick-filter", "quick-filter-placeholder", "pagination-controls", "page-size-options","initial-filter-function", "filter-builder-function"]
}]

attributes: [{
Expand Down
5 changes: 5 additions & 0 deletions _data/components/service.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,11 @@ attributes: [{
type: "() => Expression | { [key: string]: any }",
since: "15.8.3",
description: "Callback function that returns an initial filter to be applied on every query."
},{
name : "filter-builder-function",
type: "() => OFilterBuilderComponent",
description: "Callback function that resolves the OFilterBuilderComponent instance",
since: "15.9.0"
}]


Expand Down
52 changes: 52 additions & 0 deletions docs/components/o_service_components/01-o-service.component.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,58 @@ initialFilterFunction(): { [key: string]: any } {
* **Execution on every query**: The callback is invoked on every request made by the component, including pagination, sorting, and refresh actions. Ensure the function is lightweight and side-effect free.
* **Compatibility**: This input is available on all components that extend OServiceComponent, including o-table, o-grid, o-list, and similar data-bound components.

## Filter builder function

The `filter-builder-function` input allows associating an [`o-filter-builder`](../../data/filterbuilder/overview)
component with any component that extends `OServiceComponent` (such as `o-table`, `o-list`, `o-grid` or `o-data-view`)
when a direct template reference is not possible or when the instance needs to be resolved dynamically at query time.

This input accepts a callback function with no parameters that returns the `OFilterBuilderComponent` instance to use.
Every time the component performs a data query, it will call this function to retrieve the filter builder and apply
its expression.

> This approach is an alternative to calling the `setFilterBuilder()` method directly on the component. Use
> `filter-builder-function` when the `o-filter-builder` is defined in a different part of the template, such as
> in a parent component or inside an `o-data-view`.

**Examples**

```html

<o-form editable-detail="no" show-header="no">

<o-column title="FILTERS">
<o-text-input attr="NAME" read-only="no"></o-text-input>
<o-row layout-align="end">
<o-button attr="filter" [oFilterBuilderQuery]="filterBuilder" type="RAISED" label="Filter"></o-button>
<o-button attr="clear" [oFilterBuilderClear]="filterBuilder" type="RAISED" label="Clear"></o-button>
</o-row>
</o-column>

<o-filter-builder #filterBuilder attr="thefilter" filters="EMPLOYEENAME:NAME" [target]="tableEmployees"
[expression-builder]="createFilter">
</o-filter-builder>

<o-table *ngIf="defaultView === 'table'" #tableEmployees attr="tableEmployees" service="employees" entity="employee"
columns="EMPLOYEEID;EMPLOYEENAME;EMPLOYEESURNAME" keys="EMPLOYEEID"
[filter-builder-function]="getFilterBuilder">
</o-table>
<o-grid *ngIf="defaultView === 'grid'" #gridEmployees attr="gridEmployees" service="employees" entity="employee"
columns="EMPLOYEEID;EMPLOYEENAME;EMPLOYEESURNAME" keys="EMPLOYEEID"
[filter-builder-function]="getFilterBuilder">

</o-form>

```

```ts
...
@ViewChild('filterBuilder') filterBuilder: OFilterBuilderComponent;
protected getFilterBuilder = () => this.filterBuilder;
...
```


## Navigation to record detail
In the service components, the default action when user clicks a item is to trigger the navigation to its record detail. For changing this behaviour, the user can change the `detail-mode` input value using one of the following values `none`, `click` or `doubleclick`.

Expand Down
Loading