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: generate cem #7613

Merged
merged 146 commits into from
Jan 10, 2024
Merged
Show file tree
Hide file tree
Changes from 111 commits
Commits
Show all changes
146 commits
Select commit Hold shift + click to select a range
04271de
docs: generate cem
Sep 20, 2023
ce8470f
chore: cleanup
Sep 20, 2023
53558c0
chore: migrate button
Sep 26, 2023
34fa365
chore: generate manifest for base
Sep 26, 2023
4271fab
chore: cleanup
Sep 26, 2023
2c02ab8
Merge remote-tracking branch 'origin/main' into new-cem
vladitasev Oct 4, 2023
91ba52e
chore: enhance
Oct 3, 2023
d9d58c4
chore: align storybook to use cem
Oct 9, 2023
7387bcc
chore: 09/10
Oct 9, 2023
96fdd35
chore: 10.10
Oct 10, 2023
cb0517b
chore: add validator for manifest
Oct 11, 2023
feae7c7
chore: add valid jsdoc tags
Oct 11, 2023
9c36b48
chore: improve validators
Oct 12, 2023
9c59c34
chore: migrate samples prepare to storybook
Oct 13, 2023
7ad3425
chore: ts
Oct 16, 2023
beb9d97
chore: fix missing tags
Oct 17, 2023
a7784a9
Merge branch 'main' into new-cem
Oct 17, 2023
161857c
chore: clean
Oct 17, 2023
19f59fb
chore: correct deps
Oct 17, 2023
7872477
chore: fix scripts
Oct 17, 2023
1a12b35
chore: validate tags
Oct 17, 2023
fa487fc
chore: optional execution of script
Oct 17, 2023
a1f7f14
chore: sampels docs
Oct 17, 2023
4394906
chore: restore previous scripts and enable cem for base
Oct 17, 2023
05b188f
chore: fix validation of @default
Oct 17, 2023
31ce716
chore: fix storybook build
Oct 17, 2023
2550a0b
chore: fix schema and add missing tags
Oct 18, 2023
38f4cce
Merge remote-tracking branch 'origin' into new-cem
Oct 19, 2023
6fa80f9
chore: restore bundle
Oct 19, 2023
a28e5f5
chore: add param type
Oct 19, 2023
5b5793d
Merge remote-tracking branch 'origin' into new-cem
Oct 19, 2023
3b2708a
chore: generate new manifest
Oct 20, 2023
b7ba762
fix: chore description
Oct 20, 2023
3923f9b
fix: param / unnamed slots privacy
Oct 20, 2023
0ebecca
chore: show css parts
Oct 23, 2023
00e28cb
chore: extract storybook
Oct 23, 2023
99bbfe3
chore: restore nps script
Oct 23, 2023
c60651c
chore: restore component migration
Oct 23, 2023
4483b88
Merge remote-tracking branch 'origin' into new-cem
Oct 23, 2023
61d9625
fix: default value
Oct 23, 2023
e9ed3e2
fix: enum schema validation
Oct 25, 2023
7d71521
fix: show interfaces
Oct 27, 2023
64f15d0
fix: ts files path
Oct 31, 2023
962816c
Merge remote-tracking branch 'origin' into new-cem
Nov 7, 2023
2582ea8
chore: refacotor, fix validation, add internal json
Nov 10, 2023
ecfa2bc
chore: update schema and validation
Nov 10, 2023
99e04af
Merge remote-tracking branch 'origin' into new-cem
Nov 10, 2023
1bdc15a
chore: add yarnlock
Nov 10, 2023
e10177e
Merge remote-tracking branch 'origin' into new-cem
Nov 10, 2023
cd086e3
chore: fix event param types
Nov 10, 2023
94a3f1d
fix: show event params
Nov 13, 2023
a0badba
fix: display only public ones
Nov 13, 2023
1484baf
chore: restore input paths
Nov 13, 2023
30308d2
Merge remote-tracking branch 'origin' into new-cem
Nov 14, 2023
22e0cac
chore: refactor
Nov 14, 2023
24039b5
chore: update schema
Nov 14, 2023
aadf607
chore: restore paths
Nov 14, 2023
231da31
Merge remote-tracking branch 'origin' into new-cem
Nov 20, 2023
c1965f5
chore: add override for getters, methods, props
Nov 20, 2023
7a3954f
docs: new cem for Topic-P components - Icon (#7810)
plamenivanov91 Nov 21, 2023
29ddd0b
Merge remote-tracking branch 'origin/main' into new-cem
Nov 21, 2023
8d79551
docs: new cem for Topic-P components - ShellBar (#7823)
plamenivanov91 Nov 21, 2023
af54a8c
Merge remote-tracking branch 'origin/new-cem' into new-cem
Nov 21, 2023
20ba50e
chore: add privacy for shellbar events
Nov 21, 2023
d8de813
chore: ehnance validator
Nov 22, 2023
04598ad
chore: add storybook
Nov 23, 2023
0d84bbd
chore: migrate base package
Nov 23, 2023
75e62dd
chore: add correct export definition
Nov 26, 2023
61a24c2
Merge remote-tracking branch 'origin/main' into new-cem
Nov 26, 2023
531ed44
docs(ui5-rating-indicator): improve documentation (#7915)
niyap Nov 27, 2023
5f1a3f4
Merge remote-tracking branch 'origin/new-cem' into new-cem
Nov 27, 2023
28b726b
docs(ui5-textarea): improve documentation (#7913)
niyap Nov 27, 2023
92ab975
chore: fix some components values and make storybook to work
Nov 27, 2023
0032fa6
docs(ui5-slider, ui5-range-slider): enhance documentation (#7910)
niyap Nov 27, 2023
3dabefe
chore: cleanup
Nov 27, 2023
1c71230
docs: new cem for Topic-P components - Toolbar (#7814)
plamenivanov91 Nov 28, 2023
eb847ea
docs: new cem for Topic-P components - List (#7824)
plamenivanov91 Nov 28, 2023
9d6ae8d
chore: fulfill list
Nov 28, 2023
96633f4
docs(ui5-message-strip): improve documentation (#7917)
niyap Nov 28, 2023
392714b
docs(ui5-toast): improve documentation (#7914)
niyap Nov 28, 2023
7c401d9
docs: new cem for Topic-P components (#7851)
yanaminkova Nov 29, 2023
14e8f9f
docs: new cem for Topic-P components (#7850)
yanaminkova Nov 29, 2023
1445d3b
chore: fulfill
Nov 29, 2023
b59d531
docs: new cem for Topic-P components - Tree (#7927)
plamenivanov91 Nov 29, 2023
9d94d92
chore: fullfill
Nov 29, 2023
65f757b
Merge remote-tracking branch 'origin/main' into new-cem
Nov 29, 2023
ad3a710
docs(ui5-panel): improve documentation (#7924)
niyap Nov 29, 2023
7db5b50
docs(ui5-page): improve documentation (#7919)
niyap Nov 29, 2023
c3a9185
docs: rewrite JSDoc for custom-elements-manifest/analyzer (#7778)
s-todorova Nov 30, 2023
91eb258
chore: ts build
Nov 30, 2023
0b0662a
Merge remote-tracking branch 'origin/main' into new-cem
Nov 30, 2023
8021cca
docs: Adapt JSDocs for new CЕM and Remove Redundancies (#7922)
NHristov-sap Nov 30, 2023
73239b4
docs(ui5-wizard): improve documentation (#7935)
niyap Nov 30, 2023
29f8245
docs(ui5-combobox): improve documentation (#7942)
niyap Nov 30, 2023
6ee8839
chore: execute package script
Dec 1, 2023
ac10473
chore: extract type of parameters with default and enhace storybook
Dec 1, 2023
a41e7d7
docs(ui5-multi-combobox): improve documentation (#7944)
niyap Dec 4, 2023
112a666
chore: fix missed files
Dec 4, 2023
e278d6c
Merge remote-tracking branch 'origin' into new-cem
Dec 4, 2023
650675f
chore: fixes
Dec 4, 2023
1b3476f
chore: fix superclass references
Dec 5, 2023
eefad10
chore: fix paths
Dec 5, 2023
e8dacfd
chore: align exports with modules name
Dec 6, 2023
e1c8af9
chore: fix datepicker
Dec 8, 2023
025213d
Merge remote-tracking branch 'origin' into new-cem
Dec 8, 2023
c95dacf
chore: add _ui5validator
Dec 8, 2023
96f0199
docs(ui5-table): improve documentation (#7951)
niyap Dec 11, 2023
9357675
docs(ui5-input, ui5-multi-input): improve documentation (#7969)
niyap Dec 11, 2023
c106f0c
Merge remote-tracking branch 'origin/main' into new-cem
Dec 11, 2023
01292c5
chore: fixes
Dec 11, 2023
84cd8f4
chore: update schema
Dec 11, 2023
093780b
chore: handle non metadata props
Dec 12, 2023
846625f
chore: fix select
Dec 12, 2023
74f8615
fix tree
Dec 12, 2023
be0502e
fix tree items
Dec 12, 2023
c4b8c27
fix tree
Dec 12, 2023
828f59a
review comments
Dec 12, 2023
494398c
Merge remote-tracking branch 'origin/main' into new-cem
Dec 12, 2023
46ee547
chore: aling interfaces
Dec 13, 2023
9925e8c
cleanup interfaces
Dec 13, 2023
0b1740d
chore: tab container
Dec 13, 2023
eb6f634
Merge remote-tracking branch 'origin/main' into new-cem
Dec 15, 2023
ec0f86b
chor: tab container interface
Dec 15, 2023
a66098d
chore: return type of color palette popover
Dec 15, 2023
730221d
chore: fix tree test
Dec 15, 2023
d600ab2
escaped new lines
Dec 18, 2023
d80f8ec
remove parts
Dec 18, 2023
58df892
Merge remote-tracking branch 'origin/main' into new-cem
Dec 19, 2023
7dbd4f6
Merge remote-tracking branch 'origin/main' into new-cem
Jan 3, 2024
3606d42
optimizations
Jan 3, 2024
2a08652
Merge remote-tracking branch 'origin/main' into new-cem
Jan 4, 2024
5a4f49e
chore: fix pathds
Jan 4, 2024
be4ec4d
Merge remote-tracking branch 'origin/main' into new-cem
Jan 5, 2024
cbeea3a
Merge remote-tracking branch 'origin/main' into new-cem
Jan 8, 2024
2a0c49a
chore: make some components private
vladitasev Jan 8, 2024
75b9cd0
fix schema validation and cleanup
Jan 8, 2024
6e8e4dc
ehance customElement decorator
Jan 8, 2024
9c849b4
customElement decorator
Jan 8, 2024
e82ec81
fix globs pattern
Jan 9, 2024
90471ec
makr correctly custom elements
Jan 9, 2024
085bc25
corrections
Jan 9, 2024
1373b4c
chore: 2 interfaces added
vladitasev Jan 9, 2024
e24881a
chore: 2 more fixes
vladitasev Jan 9, 2024
d4b3e78
chore: fix label and token
vladitasev Jan 9, 2024
e41ec75
chore: do not sort props
vladitasev Jan 9, 2024
8c7ace8
Merge remote-tracking branch 'origin/main' into new-cem
Jan 10, 2024
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 docs/6-contributing/04-writing-samples.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ The above example includes only the `indeterminate`, `checked` properties in the


## Documentation
The documentation for each component is automatically produced using the `custom-elements.json` file. Additionally, there is an `argTypes.ts` file located beside each `.stories.ts` file. It is generated during build time and contains extra properties that enhance the documentation beyond what is available in the `custom-elements.json` file. This file should not be edited directly, as it can only be modified by the `packages/playground/build-scripts-storybook/samples-prepare.js` script.
The documentation for each component is automatically produced using the `custom-elements.json` file. Additionally, there is an `argTypes.ts` file located beside each `.stories.ts` file. It is generated during build time and contains extra properties that enhance the documentation beyond what is available in the `custom-elements.json` file. This file should not be edited directly, as it can only be modified by the `packages/playground/build-scripts-storybook/samples-prepare.ts` script.

### Docs page
Every story has a `docs` page in the storybook's sidebar. Usually, this page is generated automatically by storybook but it can be customized by adding a `docs` property to the story parameters.
Expand Down
9 changes: 3 additions & 6 deletions packages/base/package-scripts.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,6 @@ const stylesScript = resolve.sync("@ui5/webcomponents-base/lib/generate-styles/i
const versionScript = resolve.sync("@ui5/webcomponents-base/lib/generate-version-info/index.js");
const copyUsedModules = resolve.sync("@ui5/webcomponents-tools/lib/copy-list/index.js");
const esmAbsToRel = resolve.sync("@ui5/webcomponents-tools/lib/esm-abs-to-rel/index.js");
const preprocessJSDocScript = resolve.sync("@ui5/webcomponents-tools/lib/jsdoc/preprocess.js");

const LIB = path.join(__dirname, `../tools/lib/`);

Expand Down Expand Up @@ -43,11 +42,9 @@ const scripts = {
generateStyles: `node "${stylesScript}"`,
generateTemplates: `mkdirp src/generated/templates && cross-env UI5_BASE=true UI5_TS=true node "${LIB}/hbs2ui5/index.js" -d test/elements -o src/generated/templates`,
generateAPI: {
default: "nps generateAPI.prepare generateAPI.preprocess generateAPI.jsdoc generateAPI.cleanup",
prepare: `copy-and-watch "dist/**/*.js" jsdoc-dist/`,
preprocess: `node "${preprocessJSDocScript}" jsdoc-dist/`,
jsdoc: `jsdoc -c "${LIB}/jsdoc/configTypescript.json"`,
cleanup: "rimraf jsdoc-dist/"
default: "nps generateAPI.generateCEM",
generateCEM: `cem analyze --config "${LIB}/cem/custom-elements-manifest.config.mjs"`,
validateCEM: `node "${LIB}/cem/validate.js"`,
},
watch: {
default: 'concurrently "nps watch.src" "nps watch.styles"',
Expand Down
21 changes: 5 additions & 16 deletions packages/base/src/MediaRange.ts
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,6 @@ DEAFULT_RANGE_SET.set("XL", [1440, Infinity]);
/**
* Enumeration containing the names and settings of predefined screen width media query range sets.
*
* @namespace
* @name MediaRange.RANGESETS
* @public
*/
enum RANGESETS {
Expand All @@ -27,7 +25,6 @@ DEAFULT_RANGE_SET.set("XL", [1440, Infinity]);
* <li><code>"XL"</code>: For screens greater than or equal to 1440 pixels.</li>
* </ul>
*
* @name MediaRange.RANGESETS.RANGE_4STEPS
* @public
*/
RANGE_4STEPS = "4Step",
Expand All @@ -49,10 +46,9 @@ DEAFULT_RANGE_SET.set("XL", [1440, Infinity]);
* <li><code>"Large"</code>: For screens greater than or equal to 400 pixels.</li>
* </ul>
*
* @param {string} name The name of the range set to be initialized.
* @param name The name of the range set to be initialized.
* The name must be a valid id and consist only of letters and numeric digits.
* @param {Range} [range] The given range set.
* @name MediaRange.initRangeSet
* @param range The given range set.
*/
const initRangeSet = (name: string, range: Range) => {
mediaRanges.set(name, range);
Expand All @@ -64,13 +60,10 @@ const initRangeSet = (name: string, range: Range) => {
* If the optional parameter <code>width</code> is given, the active range will be determined for that width,
* otherwise it is determined for the current window size.
*
* @param {string} name The name of the range set. The range set must be initialized beforehand ({@link MediaRange.initRangeSet})
* @param {number} [width] An optional width, based on which the range should be determined;
* @param name The name of the range set. The range set must be initialized beforehand ({@link MediaRange.initRangeSet})
* @param [width] An optional width, based on which the range should be determined;
* If <code>width</code> is not provided, the window size will be used.
* @returns {string} The name of the current active interval of the range set.
*
* @name MediaRange.getCurrentRange
* @function
* @returns The name of the current active interval of the range set.
* @public
*/
const getCurrentRange = (name: string, width = window.innerWidth): string => {
Expand All @@ -94,11 +87,7 @@ const getCurrentRange = (name: string, width = window.innerWidth): string => {

/**
* API for screen width changes.
*
* @namespace
* @name MediaRange
*/

const MediaRange = {
RANGESETS,
initRangeSet,
Expand Down
6 changes: 2 additions & 4 deletions packages/base/src/StaticAreaItem.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,9 +10,7 @@ const pureTagName = "ui5-static-area-item";
const popupIntegrationAttr = "data-sap-ui-integration-popup-content";

/**
*
* @class
* @author SAP SE
* @private
*/
class StaticAreaItem extends HTMLElement {
Expand All @@ -26,7 +24,7 @@ class StaticAreaItem extends HTMLElement {
}

/**
* @param {UI5Element} ownerElement the UI5Element instance that owns this static area item
* @param ownerElement the UI5Element instance that owns this static area item
*/
setOwnerElement(ownerElement: UI5Element) {
this.ownerElement = ownerElement;
Expand Down Expand Up @@ -83,8 +81,8 @@ class StaticAreaItem extends HTMLElement {
}

/**
* @protected
* Returns reference to the DOM element where the current fragment is added.
* @protected
*/
async getDomRef() {
this.updateAdditionalProperties();
Expand Down
Loading