Skip to content
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.

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

docs: new cem for Topic-P components - Toolbar #7814

Merged
merged 16 commits into from
Nov 28, 2023

Conversation

plamenivanov91
Copy link
Contributor

Issue: #7610

-refactored toolbar related files docs
- removed unnecessary tag rom ToolbarSeparator docs
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/ToolbarButton.ts Show resolved Hide resolved
@plamenivanov91 plamenivanov91 changed the base branch from main to new-cem November 15, 2023 13:59
Copy link
Contributor

@nnaydenow nnaydenow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have few more @slot tags in the file but I'm not able to comment them since you haven't edited the file there.

Also you have IToolbarItem interface declared in ToolbarItem.ts and also in the Interfaces.ts move the definition and description on the same place.

packages/main/src/Interfaces.ts Outdated Show resolved Hide resolved
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/Toolbar.ts Outdated Show resolved Hide resolved
packages/main/src/ToolbarSelectOption.ts Outdated Show resolved Hide resolved
packages/main/src/types/ToolbarAlign.ts Outdated Show resolved Hide resolved
packages/main/src/types/ToolbarItemOverflowBehavior.ts Outdated Show resolved Hide resolved
Copy link
Contributor

@nnaydenow nnaydenow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Remove @returns tag if description is not provided. Also the type of the function / getter is read from the typescript type
  • Remove @interface tag.
  • We can remove IToolbarItem and to use class ToolbarItem instead. We need every component that is placed inside toolbar to extend it.
  • We can delete IToolbarSelectOption and to use the class instead. Also replace ISelectOption with IToolbarOption in ToolbarSelect.ts

@nnaydenow
Copy link
Contributor

Also now we have option to add @depracete, @since, @public | private | protected tags to the event params so we have to explicitly set it's privacy if we want it to be displayed into the playground.

Every param mentioned into the event comment should have privacy: public

/**
 * Fired when the selected option changes.
 *
 * @allowPreventDefault
 * @param {HTMLElement} selectedOption the selected option.
 * @public
 */
@event("change", {
	detail: {
                /**
                * @public
                */
		selectedOption: { type: HTMLElement },
	},
})

packages/main/src/Interfaces.ts Outdated Show resolved Hide resolved
packages/main/src/ToolbarSelect.ts Outdated Show resolved Hide resolved
packages/main/src/Interfaces.ts Outdated Show resolved Hide resolved
packages/main/src/ToolbarItem.ts Outdated Show resolved Hide resolved
@nnaydenow nnaydenow merged commit 1c71230 into SAP:new-cem Nov 28, 2023
6 of 7 checks passed
nnaydenow added a commit that referenced this pull request Jan 10, 2024
* docs: generate cem

* chore: cleanup

* chore: migrate button

* chore: generate manifest for base

* chore: cleanup

* chore: enhance

* chore: align storybook to use cem

* chore: 09/10

* chore: 10.10

* chore: add validator for manifest

* chore: add valid jsdoc tags

* chore: improve validators

* chore: migrate samples prepare to storybook

* chore: ts

* chore: fix missing tags

* chore: clean

* chore: correct deps

* chore: fix scripts

* chore: validate tags

* chore: optional execution of script

* chore: sampels docs

* chore: restore previous scripts and enable cem for base

* chore: fix validation of @default

* chore: fix storybook build

* chore: fix schema and add missing tags

* chore: restore bundle

* chore: add param type

* chore: generate new manifest

* fix: chore description

* fix: param / unnamed slots privacy

* chore: show css parts

* chore: extract storybook

* chore: restore nps script

* chore: restore component migration

* fix: default value

* fix: enum schema validation

* fix: show interfaces

* fix: ts files path

* chore: refacotor, fix validation, add internal json

* chore: update schema and validation

* chore: add yarnlock

* chore: fix event param types

* fix: show event params

* fix: display only public ones

* chore: restore input paths

* chore: refactor

* chore: update schema

* chore: restore paths

* chore: add override for getters, methods, props

* docs: new cem for Topic-P components - Icon (#7810)

* docs: new cem for Topic-P components - Icon
Issue: #7610

* docs: new cem for Topic-P components - Icon
-fixed review comments

* docs: new cem for Topic-P components - Icon
-ignored lint error

* fix(ui5-wizard): scrollbar styles are now present on root (#7838)

* docs: new cem for Topic-P components - Icon
-removed @INTERACE jsdoc tag from interfaces file

---------

Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>

* docs: new cem for Topic-P components - ShellBar (#7823)

* docs: new cem for Topic-P components - ShellBar
Issue: #7610

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

* fix(ui5-wizard): scrollbar styles are now present on root (#7838)

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

* chore: update chromedriver to 119 (#7883)

* fix(ui5-switch): align 'off' text in RTL, add compact mode params (#7603)

In RTL mode the 'off' icon of `Graphical` type Switch was misaligned due to missing parameters for RTL scenario of the control.

Fixes: #7522 
Fixes: #7806

* fix(framework): redundant fonts loading (#7868)

fix(framework): font loading

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

---------

Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>
Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com>
Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: add privacy for shellbar events

* chore: ehnance validator

* chore: add storybook

* chore: migrate base package

* chore: add correct export definition

* docs(ui5-rating-indicator): improve documentation (#7915)

* docs(ui5-textarea): improve documentation (#7913)

* fix(ui5-textarea): improve documentation

* docs(ui5-textarea): reflect comments

* chore: fix some components values and make storybook to work

* docs(ui5-slider, ui5-range-slider): enhance documentation (#7910)

* fix(ui5-slider, ui5-range-slider): enhance documentation

* docs(ui5-slider, ui5-range-slider): reflect review comments

* chore: cleanup

* docs: new cem for Topic-P components - Toolbar (#7814)

* docs: new cem for Topic-P components - Toolbar
Issue: #7610

* docs: new cem for Topic-P components - Toolbar
-refactored toolbar related files docs

* docs: new cem for Topic-P components - Toolbar
- removed unnecessary tag rom ToolbarSeparator docs

* docs: new cem for Topic-P components - Toolbar
-fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - List (#7824)

* docs: new cem for Topic-P components - List
Issue: #7610

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* chore: fulfill list

* docs(ui5-message-strip): improve documentation (#7917)

* docs(ui5-message-strip): improve documentation

* docs(ui5-message-strip): reflect review comments

* docs(ui5-toast): improve documentation (#7914)

* docs(ui5-toast): improve documentation

* docs(ui5-toast): reflect review comments

* docs: new cem for Topic-P components (#7851)

* docs: new cem for Topic-P components (#7850)

* docs: new cem for Topic-P components - ui5-select

* docs: new cem for Topic-P components - ui5-select

* docs: new cem for Topic-P components

* docs: new cem for Topic-P components

---------

Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>

* chore: fulfill

* docs: new cem for Topic-P components - Tree (#7927)

* fix(ui5-textarea): adjust scroll positioning (#7920)

* docs(ui5-select-menu-option): correct disabled property description (#7925)

docs(ui5-select-menu-option): correct docs

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs: new cem for Topic-P components - Tree
Issue: #7610

* docs: new cem for Topic-P components - Tree
-fixed review comments

---------

Co-authored-by: niyap <38278268+niyap@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: fullfill

* docs(ui5-panel): improve documentation (#7924)

* docs(ui5-panel): improve documentation

* docs(ui5-panel): reflect review comments

* docs(ui5-panel): reflect review comments

* docs(ui5-page): improve documentation (#7919)

* docs: rewrite JSDoc for custom-elements-manifest/analyzer (#7778)

* docs: new cem for Topic-RD components

JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components.
Issue: #7610

* docs: remove types from enums

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* chore: fulfill

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: ts build

* docs: Adapt JSDocs for new CЕM and Remove Redundancies (#7922)

* docs: Adapt JSDocs for new CЕM and Remove Redundancies

* docs: fix merge conflict

* docs: adapt docs to updated specs

* docs: fix storybook errors

* docs: add missing file

* docs: update interfaces

* docs: fix comments

* docs: fix more comments

* docs: another comments fix

* docs: fix more comments

* docs: fix comments

* docs: fix ITtimelineItem interface properties

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs(ui5-wizard): improve documentation (#7935)

* docs(ui5-wizard): improve documentation

* docs(ui5-wizard): reflect review comments

* docs(ui5-combobox): improve documentation (#7942)

* chore: execute package script

* chore: extract type of parameters with default and enhace storybook

* docs(ui5-multi-combobox): improve documentation (#7944)

* chore: fix missed files

* chore: fixes

* chore: fix superclass references

* chore: fix paths

* chore: align exports with modules name

* chore: fix datepicker

* chore: add _ui5validator

* docs(ui5-table): improve documentation (#7951)

* docs(ui5-table): improve documentation

* docs(ui5-table): reflect review comments

---------

Co-authored-by: Nia Peeva <niya.peeva@sap.com>

* docs(ui5-input, ui5-multi-input): improve documentation (#7969)

Co-authored-by: Nia Peeva <niya.peeva@sap.com>

* chore: fixes

* chore: update schema

* chore: handle non metadata props

* chore: fix select

* fix tree

* fix tree items

* fix tree

* review comments

* chore: aling interfaces

* cleanup interfaces

* chore: tab container

* chor: tab container interface

* chore: return type of color palette popover

* chore: fix tree test

* escaped new lines

* remove parts

* optimizations

* chore: fix pathds

* chore: make some components private

* fix schema validation and cleanup

* ehance customElement decorator

* customElement decorator

* fix globs pattern

* makr correctly custom elements

* corrections

* chore: 2 interfaces added

* chore: 2 more fixes

* chore: fix label and token

* chore: do not sort props

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>
Co-authored-by: Vladislav Tasev <vladislav.tasev@sap.com>
Co-authored-by: Plamen Ivanov <plamen.ivanov01@sap.com>
Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>
Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com>
Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com>
Co-authored-by: niyap <38278268+niyap@users.noreply.github.com>
Co-authored-by: yanaminkova <32466553+yanaminkova@users.noreply.github.com>
Co-authored-by: Siyana Todorova <72251110+s-todorova@users.noreply.github.com>
Co-authored-by: Nikolay Hristov <n.hristov@sap.com>
Co-authored-by: Nia Peeva <niya.peeva@sap.com>
PetyaMarkovaBogdanova pushed a commit that referenced this pull request Jan 17, 2024
* docs: generate cem

* chore: cleanup

* chore: migrate button

* chore: generate manifest for base

* chore: cleanup

* chore: enhance

* chore: align storybook to use cem

* chore: 09/10

* chore: 10.10

* chore: add validator for manifest

* chore: add valid jsdoc tags

* chore: improve validators

* chore: migrate samples prepare to storybook

* chore: ts

* chore: fix missing tags

* chore: clean

* chore: correct deps

* chore: fix scripts

* chore: validate tags

* chore: optional execution of script

* chore: sampels docs

* chore: restore previous scripts and enable cem for base

* chore: fix validation of @default

* chore: fix storybook build

* chore: fix schema and add missing tags

* chore: restore bundle

* chore: add param type

* chore: generate new manifest

* fix: chore description

* fix: param / unnamed slots privacy

* chore: show css parts

* chore: extract storybook

* chore: restore nps script

* chore: restore component migration

* fix: default value

* fix: enum schema validation

* fix: show interfaces

* fix: ts files path

* chore: refacotor, fix validation, add internal json

* chore: update schema and validation

* chore: add yarnlock

* chore: fix event param types

* fix: show event params

* fix: display only public ones

* chore: restore input paths

* chore: refactor

* chore: update schema

* chore: restore paths

* chore: add override for getters, methods, props

* docs: new cem for Topic-P components - Icon (#7810)

* docs: new cem for Topic-P components - Icon
Issue: #7610

* docs: new cem for Topic-P components - Icon
-fixed review comments

* docs: new cem for Topic-P components - Icon
-ignored lint error

* fix(ui5-wizard): scrollbar styles are now present on root (#7838)

* docs: new cem for Topic-P components - Icon
-removed @INTERACE jsdoc tag from interfaces file

---------

Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>

* docs: new cem for Topic-P components - ShellBar (#7823)

* docs: new cem for Topic-P components - ShellBar
Issue: #7610

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

* fix(ui5-wizard): scrollbar styles are now present on root (#7838)

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

* chore: update chromedriver to 119 (#7883)

* fix(ui5-switch): align 'off' text in RTL, add compact mode params (#7603)

In RTL mode the 'off' icon of `Graphical` type Switch was misaligned due to missing parameters for RTL scenario of the control.

Fixes: #7522 
Fixes: #7806

* fix(framework): redundant fonts loading (#7868)

fix(framework): font loading

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs: new cem for Topic-P components - ShellBar
- fixed review comments

---------

Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>
Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com>
Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: add privacy for shellbar events

* chore: ehnance validator

* chore: add storybook

* chore: migrate base package

* chore: add correct export definition

* docs(ui5-rating-indicator): improve documentation (#7915)

* docs(ui5-textarea): improve documentation (#7913)

* fix(ui5-textarea): improve documentation

* docs(ui5-textarea): reflect comments

* chore: fix some components values and make storybook to work

* docs(ui5-slider, ui5-range-slider): enhance documentation (#7910)

* fix(ui5-slider, ui5-range-slider): enhance documentation

* docs(ui5-slider, ui5-range-slider): reflect review comments

* chore: cleanup

* docs: new cem for Topic-P components - Toolbar (#7814)

* docs: new cem for Topic-P components - Toolbar
Issue: #7610

* docs: new cem for Topic-P components - Toolbar
-refactored toolbar related files docs

* docs: new cem for Topic-P components - Toolbar
- removed unnecessary tag rom ToolbarSeparator docs

* docs: new cem for Topic-P components - Toolbar
-fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - Toolbar
- fixed review comments

* docs: new cem for Topic-P components - List (#7824)

* docs: new cem for Topic-P components - List
Issue: #7610

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* docs: new cem for Topic-P components - List
- fixed review comments

* chore: fulfill list

* docs(ui5-message-strip): improve documentation (#7917)

* docs(ui5-message-strip): improve documentation

* docs(ui5-message-strip): reflect review comments

* docs(ui5-toast): improve documentation (#7914)

* docs(ui5-toast): improve documentation

* docs(ui5-toast): reflect review comments

* docs: new cem for Topic-P components (#7851)

* docs: new cem for Topic-P components (#7850)

* docs: new cem for Topic-P components - ui5-select

* docs: new cem for Topic-P components - ui5-select

* docs: new cem for Topic-P components

* docs: new cem for Topic-P components

---------

Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>

* chore: fulfill

* docs: new cem for Topic-P components - Tree (#7927)

* fix(ui5-textarea): adjust scroll positioning (#7920)

* docs(ui5-select-menu-option): correct disabled property description (#7925)

docs(ui5-select-menu-option): correct docs

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs: new cem for Topic-P components - Tree
Issue: #7610

* docs: new cem for Topic-P components - Tree
-fixed review comments

---------

Co-authored-by: niyap <38278268+niyap@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <31909318+nnaydenow@users.noreply.github.com>
Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: fullfill

* docs(ui5-panel): improve documentation (#7924)

* docs(ui5-panel): improve documentation

* docs(ui5-panel): reflect review comments

* docs(ui5-panel): reflect review comments

* docs(ui5-page): improve documentation (#7919)

* docs: rewrite JSDoc for custom-elements-manifest/analyzer (#7778)

* docs: new cem for Topic-RD components

JSDoc changes related to using the new custom-elements-manifest for Rodopi-owned components.
Issue: #7610

* docs: remove types from enums

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

* chore: fulfill

* docs: rewrite JSDoc for custom-elements-manifest/analyzer

Related to: #7610

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* chore: ts build

* docs: Adapt JSDocs for new CЕM and Remove Redundancies (#7922)

* docs: Adapt JSDocs for new CЕM and Remove Redundancies

* docs: fix merge conflict

* docs: adapt docs to updated specs

* docs: fix storybook errors

* docs: add missing file

* docs: update interfaces

* docs: fix comments

* docs: fix more comments

* docs: another comments fix

* docs: fix more comments

* docs: fix comments

* docs: fix ITtimelineItem interface properties

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>

* docs(ui5-wizard): improve documentation (#7935)

* docs(ui5-wizard): improve documentation

* docs(ui5-wizard): reflect review comments

* docs(ui5-combobox): improve documentation (#7942)

* chore: execute package script

* chore: extract type of parameters with default and enhace storybook

* docs(ui5-multi-combobox): improve documentation (#7944)

* chore: fix missed files

* chore: fixes

* chore: fix superclass references

* chore: fix paths

* chore: align exports with modules name

* chore: fix datepicker

* chore: add _ui5validator

* docs(ui5-table): improve documentation (#7951)

* docs(ui5-table): improve documentation

* docs(ui5-table): reflect review comments

---------

Co-authored-by: Nia Peeva <niya.peeva@sap.com>

* docs(ui5-input, ui5-multi-input): improve documentation (#7969)

Co-authored-by: Nia Peeva <niya.peeva@sap.com>

* chore: fixes

* chore: update schema

* chore: handle non metadata props

* chore: fix select

* fix tree

* fix tree items

* fix tree

* review comments

* chore: aling interfaces

* cleanup interfaces

* chore: tab container

* chor: tab container interface

* chore: return type of color palette popover

* chore: fix tree test

* escaped new lines

* remove parts

* optimizations

* chore: fix pathds

* chore: make some components private

* fix schema validation and cleanup

* ehance customElement decorator

* customElement decorator

* fix globs pattern

* makr correctly custom elements

* corrections

* chore: 2 interfaces added

* chore: 2 more fixes

* chore: fix label and token

* chore: do not sort props

---------

Co-authored-by: Nayden Naydenov <nnaydenow.work@sap.com>
Co-authored-by: Vladislav Tasev <vladislav.tasev@sap.com>
Co-authored-by: Plamen Ivanov <plamen.ivanov01@sap.com>
Co-authored-by: Ivaylo Plashkov <ivaylo.plashkov@sap.com>
Co-authored-by: ilhan orhan <ilhan.orhan007@gmail.com>
Co-authored-by: Stoyan <88034608+hinzzx@users.noreply.github.com>
Co-authored-by: niyap <38278268+niyap@users.noreply.github.com>
Co-authored-by: yanaminkova <32466553+yanaminkova@users.noreply.github.com>
Co-authored-by: Siyana Todorova <72251110+s-todorova@users.noreply.github.com>
Co-authored-by: Nikolay Hristov <n.hristov@sap.com>
Co-authored-by: Nia Peeva <niya.peeva@sap.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants