diff --git a/.github/workflows/docs-release.yml b/.github/workflows/docs-release.yml index ed04c100c..606c39b26 100644 --- a/.github/workflows/docs-release.yml +++ b/.github/workflows/docs-release.yml @@ -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: @@ -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') }} diff --git a/_config.yml b/_config.yml index 219c1c159..2b7662f52 100644 --- a/_config.yml +++ b/_config.yml @@ -22,6 +22,9 @@ versions: - url: /docs/v15 title: 15.x.x selected: true + - url: /docs/next + title: next + selected: false page_excerpts: true diff --git a/_data/components/appLayout.yml b/_data/components/appLayout.yml index 2a9851522..927de708c 100644 --- a/_data/components/appLayout.yml +++ b/_data/components/appLayout.yml @@ -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**", } ] diff --git a/_data/components/grid.yml b/_data/components/grid.yml index fdc18375c..758410447 100644 --- a/_data/components/grid.yml +++ b/_data/components/grid.yml @@ -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" diff --git a/_data/components/list.yml b/_data/components/list.yml index f3262f1dc..ceafb6b86 100644 --- a/_data/components/list.yml +++ b/_data/components/list.yml @@ -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" },{ @@ -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" diff --git a/_data/components/otableData/00table.yml b/_data/components/otableData/00table.yml index a31baf6f7..6a12ac583 100644 --- a/_data/components/otableData/00table.yml +++ b/_data/components/otableData/00table.yml @@ -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" },{ @@ -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: [{ diff --git a/_data/components/service.yml b/_data/components/service.yml index 272686f77..1afa5b450 100644 --- a/_data/components/service.yml +++ b/_data/components/service.yml @@ -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", diff --git a/_data/menu_descriptions.yml b/_data/menu_descriptions.yml index ea819a0fa..6dc272541 100644 --- a/_data/menu_descriptions.yml +++ b/_data/menu_descriptions.yml @@ -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" @@ -417,4 +417,4 @@ sections: imagepath: "/assets/images/menus/addons/keycloak" - url: "/addons/report/" title: "Report" - imagepath: "/assets/images/menus/addons/report" \ No newline at end of file + imagepath: "/assets/images/menus/addons/report" diff --git a/assets/images/layouts/app-layout/app-layout-show-ellipsis-menu.png b/assets/images/layouts/app-layout/app-layout-show-ellipsis-menu.png new file mode 100644 index 000000000..d1dea1c8f Binary files /dev/null and b/assets/images/layouts/app-layout/app-layout-show-ellipsis-menu.png differ diff --git a/docs/aditional-information/52-versions.md b/docs/aditional-information/52-versions.md index 053944220..dc636b03d 100644 --- a/docs/aditional-information/52-versions.md +++ b/docs/aditional-information/52-versions.md @@ -28,6 +28,40 @@ In this section you can check the different releases of **OntimizeWeb** and its + + 15.5.4 + 15.0.0 + 15.0.1
15.0.0 + 15.1.6
15.1.5
15.1.4
15.1.3
15.1.2
15.1.1
15.1.0
15.0.1
15.0.0 + 15.1.2
15.1.1
15.1.0
15.0.0 + 15.0.3
15.0.2
15.0.1
15.0.0 + 15.1.0
15.0.0 + + + 15.5.3 + + + 15.5.2 + + + 15.5.1 + + + 15.5.0 + + + 15.4.4 + + + + 15.4.3 + + + 15.4.2 + + + 15.4.1 + 15.5.1 15.0.0 diff --git a/docs/components/layout/51-o-app-layout.component.md b/docs/components/layout/51-o-app-layout.component.md index f0a541c75..051b0049d 100644 --- a/docs/components/layout/51-o-app-layout.component.md +++ b/docs/components/layout/51-o-app-layout.component.md @@ -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 `` 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 + + + +``` + +### Show ellipsis menu new + +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 new + +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. diff --git a/docs/components/layout/57-o-form-layout-manager.component.md b/docs/components/layout/57-o-form-layout-manager.component.md index ed7b6d08d..9b9601f7d 100644 --- a/docs/components/layout/57-o-form-layout-manager.component.md +++ b/docs/components/layout/57-o-form-layout-manager.component.md @@ -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 `...` 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 `...` and inside you can define your template. It's *important* than the tabData attributes are including in `label-columns`.

Example

```html