Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
34 changes: 28 additions & 6 deletions .github/workflows/docs-release.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,24 @@
name: Release Docs
on:
workflow_dispatch:
pull_request:
types: [closed]
branches:
- 15.x.x
workflow_dispatch:
inputs:
BASELINE:
description: 'Baseline branch of documentation'
required: true
default: '15.x.x'
TARGET_FOLDER:
description: 'Target version folder'
required: true
default: 'next'
type: choice
options:
- 'v15'
- 'next'

env:
TARGET_PATH: v15

jobs:
build-docs:
Expand All @@ -16,13 +27,24 @@ jobs:
if: github.event_name == 'workflow_dispatch' ||
(github.event.pull_request.merged == true && contains(join(github.event.pull_request.labels.*.name, ', '), 'release-docs'))
steps:
- uses: actions/checkout@v3
- name: Process input parameters
run: |
if [[ "${{ github.event_name }}" == "workflow_dispatch" ]]; then
TARGET_PATH="${{ github.event.inputs.TARGET_FOLDER }}"
else
TARGET_PATH="v15"
fi
echo "TARGET_PATH=$TARGET_PATH" >> "$GITHUB_ENV"
BASELINE_BRANCH=${{ github.event.inputs.BASELINE || github.ref }}
echo "BASELINE_BRANCH=${BASELINE_BRANCH#refs/heads/}" >> "$GITHUB_ENV"

- uses: actions/checkout@v4
with:
ref: 15.x.x
ref: ${{ env.BASELINE_BRANCH }}
fetch-depth: 0

- name: Bundler Cache
uses: actions/cache@v3
uses: actions/cache@v4
with:
path: vendor/bundle
key: ${{ runner.os }}-gems-${{ hashFiles('**/Gemfile.lock') }}
Expand Down
3 changes: 3 additions & 0 deletions _config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ versions:
- url: /docs/v15
title: 15.x.x
selected: true
- url: /docs/next
title: next
selected: false

page_excerpts: true

Expand Down
17 changes: 17 additions & 0 deletions _data/components/appLayout.yml
Original file line number Diff line number Diff line change
Expand Up @@ -94,6 +94,23 @@ attributes:
default: "",
required: "",
description: "Static header title",
},{
name: "store-state",
since: "15.5.0"
}, {
name: "show-ellipsis-menu",
type: "boolean",
default: "no",
required: "",
since: "15.5.4",
description: "Indicates whether or not to show ellipsis in menu items.",
},{
name: "tooltip-display-mode",
type: "'always'| 'never' | 'only-collapsed'| 'only-expanded'",
default: "only-collapsed",
required: "",
since: "15.5.4",
description: "Defines when the tooltip should be displayed. The default value is **only-collapsed**",
}
]

Expand Down
16 changes: 4 additions & 12 deletions _data/components/grid.yml
Original file line number Diff line number Diff line change
Expand Up @@ -98,18 +98,10 @@ attributes: [{
default: "no"
}]

outputs: [{
name: "onClick",
description: "Event triggered when a row is clicked"
},{
name: "onDoubleClick",
description: "Event triggered when a row is double clicked"
},{
name: "onDataLoaded",
description: "Event triggered when the data is updated"
},{
name: "onPaginatedDataLoaded",
description: "Event triggered when the paginated data is updated"
inheritedOutputs: [{
component: "OServiceComponent",
path: "components/service/service/api",
outputs: [ 'onClick','onDoubleClick','onDataLoaded','onPaginatedDataLoaded','onSearch']
}]

extraComponents: "gridData"
Expand Down
25 changes: 16 additions & 9 deletions _data/components/list.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,12 @@ inheritedAttributes: [{
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"]
}]

inheritedOutputs: [{
component: "OServiceComponent",
path: "components/service/service/api",
outputs: [ 'onClick','onDoubleClick','onDataLoaded','onPaginatedDataLoaded','onSearch']
}]

attributes: [{
name: "quick-filter-columns"
},{
Expand Down Expand Up @@ -69,18 +75,19 @@ attributes: [{
}]

outputs: [{
name: "onDataLoaded",
description: "Event triggered when the data is loaded"
name: "onItemSelected",
description: "Event triggered when an item is selected"
},{
name: "onPaginatedDataLoaded",
description: "Event triggered when the paginated data is loaded"
name: "onItemDeselected",
description: "Event triggered when an item is deselected"
},{
name: "beforeGoEditMode",
description: "Event triggered befoe going to form edition mode"
name: "onInserButtonClick",
description: "Event triggered when the insert button is clicked"
},{
name: "onFormModeChange",
description: "Event triggered when form mode changes"
}]
name: "onItemDeleted",
description: "Event triggered when an item is deleted"
}
]

extraComponents: "listData"

Expand Down
20 changes: 5 additions & 15 deletions _data/components/otableData/00table.yml
Original file line number Diff line number Diff line change
Expand Up @@ -244,14 +244,13 @@ attributes: [{
default: "no"
}]

inheritedOutputs: [{
component: "OServiceComponent",
path: "components/service/service/api",
outputs: [ 'onClick','onDoubleClick','onDataLoaded','onPaginatedDataLoaded','onSearch']
}]

outputs: [{
name: "onClick",
description: "Event triggered when a row is clicked"
},{
name: "onDoubleClick",
description: "Event triggered when a row is double clicked"
},{
name: "onRowSelected",
description: "Event triggered when a row is selected"
},{
Expand All @@ -260,15 +259,6 @@ outputs: [{
},{
name: "onRowDeleted",
description: "Event triggered when there some row deletion"
},{
name: "onDataLoaded",
description: "Event triggered when the data is updated"
},{
name: "onPaginatedDataLoaded",
description: "Event triggered when the paginated data is updated"
},{
name: "onSearch",
description: "Event triggered when the quickfilter starts searching"
}]

methods: [{
Expand Down
18 changes: 18 additions & 0 deletions _data/components/service.yml
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,24 @@ attributes: [{
description : "Indicates which of the mat-form-field different except in o-table component[appearance variants](https://v15.material.angular.io/components/form-field/overview#form-field-appearance-variants) will be used. except in the o-table component."
}]


outputs: [{
name: "onClick",
description: "Event triggered when a row is clicked"
},{
name: "onDoubleClick",
description: "Event triggered when a row is double clicked"
},{
name: "onDataLoaded",
description: "Event triggered when the data is updated"
},{
name: "onPaginatedDataLoaded",
description: "Event triggered when the paginated data is updated"
},{
name: "onSearch",
description: "Event triggered when the quickfilter starts searching"
}]

methods: [{
name: "initialize",
type: "method",
Expand Down
4 changes: 2 additions & 2 deletions _data/menu_descriptions.yml
Original file line number Diff line number Diff line change
Expand Up @@ -288,7 +288,7 @@ sections:
title: "Creating the customers module"
description: "Exercise 2: creation of a new module and its configurations"
- url: "/tutorial/exercise3/"
title: "Creating a deatil form"
title: "Creating a detail form"
description: "Exercise 3: creation of a detail form with inputs"
- url: "/tutorial/exercise4/"
title: "Creating de employees module"
Expand Down Expand Up @@ -417,4 +417,4 @@ sections:
imagepath: "/assets/images/menus/addons/keycloak"
- url: "/addons/report/"
title: "Report"
imagepath: "/assets/images/menus/addons/report"
imagepath: "/assets/images/menus/addons/report"
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
34 changes: 34 additions & 0 deletions docs/aditional-information/52-versions.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,40 @@ In this section you can check the different releases of **OntimizeWeb** and its
</tr>
</thead>
<tbody>
<tr>
<td>15.5.4</td>
<td rowspan="27">15.0.0</td>
<td rowspan="27">15.0.1<br>15.0.0</td>
<td rowspan="27">15.1.6<br>15.1.5<br>15.1.4<br>15.1.3<br>15.1.2<br>15.1.1<br>15.1.0<br>15.0.1<br>15.0.0</td>
<td rowspan="27">15.1.2<br>15.1.1<br>15.1.0<br>15.0.0</td>
<td rowspan="27">15.0.3<br>15.0.2<br>15.0.1<br>15.0.0</td>
<td rowspan="27">15.1.0<br>15.0.0</td>
</tr>
<tr>
<td>15.5.3</td>
</tr>
<tr>
<td>15.5.2</td>
</tr>
<tr>
<td>15.5.1</td>
</tr>
<tr>
<td>15.5.0</td>
</tr>
<tr>
<td>15.4.4</td>

</tr>
<tr>
<td>15.4.3</td>
</tr>
<tr>
<td>15.4.2</td>
</tr>
<tr>
<td>15.4.1</td>
</tr>
<tr>
<td>15.5.1</td>
<td rowspan="25">15.0.0</td>
Expand Down
32 changes: 32 additions & 0 deletions docs/components/layout/51-o-app-layout.component.md
Original file line number Diff line number Diff line change
Expand Up @@ -166,6 +166,38 @@ export class MainComponent {

![Custom user info]({{ "/assets/images/layouts/app-layout/custom_user_info.png" | absolute_url }})

## Side Menu Behavior Options
The `<o-app-layout>` component is the main layout wrapper that provides a consistent structure for applications, including a top toolbar, side navigation menu, and main content area. It supports responsive behavior and is highly customizable.

Example:

```html
<o-app-layout show-ellipsis-menu="true" tooltip-display-mode="always">
<router-outlet></router-outlet>
</o-app-layout>
```

### Show ellipsis menu <span class='menuitem-badge'>new<span>

The `show-ellipsis-menu` input controls whether long menu item labels should be visually truncated with an ellipsis (`...`) when they don’t fit in the available horizontal space. By default, this behavior is disabled and text may wrap or overflow depending on layout styles.

![App layout component with show-ellipsis-menu]({{ "/assets/images/layouts/app-layout/app-layout-show-ellipsis-menu.png" | absolute_url }})


### Tooltip display behavior <span class='menuitem-badge'>new<span>

The `tooltip-display-mode` input lets you control when tooltips should appear on side navigation items. This is especially helpful when the menu is collapsed, and labels are hidden. By default, this value es `only-collapsed`

Available modes:

* **`'always'`** – Tooltips are always shown, regardless of the menu state.
* **`'never'`** – Tooltips are never shown.
* **`'only-collapsed'`** – Tooltips are shown only when the side menu is collapsed (default).
* **`'only-expanded'`** – Tooltips are shown only when the side menu is expanded.

This setting improves accessibility and user experience by offering contextual information only when it's needed.


## Images

You can set provide images to be shown in the side navigator using the attributes `opened-sidenav-image` and `closed-sidenav-image`. Check this and other attributes in the **API** section of this page.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ You can select this mode setting the value **tab** to the `mode` input. You can
#### Options
It is possible to configure tab mode options with the `o-form-layout-tabgroup-options` component. This attributes are explained in the **API** section of this page.

For complex labels, you can add `<ng-template let-tabData="tabData">...</ng-template>` and inside you can define your template. It's *important* than the tabData attributes are including in `labe-columns`.
For complex labels, you can add `<ng-template let-tabData="tabData">...</ng-template>` and inside you can define your template. It's *important* than the tabData attributes are including in `label-columns`.

<h3 class="grey-color">Example</h3>
```html
Expand Down
Loading