Skip to content

docs: prepare API docs for publishing #77

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
merged 3 commits into from
Mar 22, 2021
Merged

docs: prepare API docs for publishing #77

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
acc45fe
docs: prepare API docs for publishing
web-padawan Mar 15, 2021
29a1dfe
chore: remove individual API docs
web-padawan Mar 15, 2021
abbb565
chore: format index.html with Prettier
web-padawan Mar 19, 2021
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
4 changes: 2 additions & 2 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
node_modules
coverage
packages/**/analysis.json
packages/**/dist
dist
analysis.json
34 changes: 34 additions & 0 deletions index.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!DOCTYPE html>
<html>
<head>
<title>Vaadin web components</title>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
</head>
<body>
<style>
iron-component-page {
--app-drawer-width: 320px;
}
</style>

<iron-component-page></iron-component-page>

<script type="module">
import '@polymer/iron-component-page/iron-component-page.js';

requestAnimationFrame(() => {
setTimeout(() => {
const page = document.querySelector('iron-component-page');
const nav = page.shadowRoot.querySelector('iron-doc-nav');
const repeat = nav.shadowRoot.querySelector('dom-repeat');
// hide mixins section from the navigation
repeat.addEventListener('dom-change', () => {
const sections = nav.shadowRoot.querySelectorAll('section');
sections[sections.length - 2].setAttribute('hidden', '');
});
});
});
</script>
</body>
</html>
11 changes: 10 additions & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,13 +17,16 @@
]
},
"scripts": {
"analyze": "polymer analyze packages/**/vaadin-*.js > analysis.json && node scripts/prepareDocs.js",
"debug": "web-test-runner --watch",
"dist": "lerna run dist --stream",
"dist": "rimraf dist && yarn analyze && rollup -c rollup.config.js && cp analysis.json dist",
"docs": "yarn analyze && web-dev-server --node-resolve --open",
"lint": "npm-run-all --parallel lint:*",
"lint:css": "stylelint packages/**/src/*.js packages/**/theme/**/*-styles.js",
"lint:js": "eslint *.js scripts packages",
"lint:types": "tsc",
"preversion": "node scripts/updateVersion.js",
"serve:dist": "web-dev-server --app-index dist/index.html --open",
"test": "web-test-runner --coverage",
"test:firefox": "web-test-runner --config web-test-runner-firefox.config.js",
"test:lumo": "web-test-runner --config web-test-runner-lumo.config.js",
Expand All @@ -33,7 +36,10 @@
"update:material": "TEST_ENV=update web-test-runner --config web-test-runner-material.config.js"
},
"devDependencies": {
"@open-wc/rollup-plugin-html": "^1.2.5",
"@polymer/iron-component-page": "^4.0.0",
"@vaadin/testing-helpers": "^0.1.3",
"@web/dev-server": "^0.1.8",
"@web/test-runner": "^0.12.17",
"@web/test-runner-playwright": "^0.8.4",
"@web/test-runner-saucelabs": "^0.5.0",
Expand All @@ -47,6 +53,9 @@
"npm-run-all": "^4.1.5",
"prettier": "^2.2.1",
"replace-in-file": "^6.2.0",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"stylelint": "^13.11.0",
"stylelint-config-prettier": "^8.0.2",
"stylelint-config-vaadin": "^0.2.10",
Expand Down
16 changes: 0 additions & 16 deletions packages/vaadin-accordion/index.html
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions packages/vaadin-accordion/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"src",
"theme"
],
"scripts": {
"dist": "rimraf dist && polymer analyze vaadin-* > analysis.json && rollup -c rollup.config.js && cp analysis.json dist"
},
"dependencies": {
"@polymer/polymer": "^3.0.0",
"@vaadin/vaadin-details": "^20.0.0-alpha1",
Expand All @@ -37,13 +34,8 @@
},
"devDependencies": {
"@esm-bundle/chai": "^4.1.5",
"@open-wc/rollup-plugin-html": "^1.2.5",
"@open-wc/testing-helpers": "^1.8.12",
"@polymer/iron-component-page": "^4.0.0",
"@polymer/iron-test-helpers": "^3.0.0",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"sinon": "^9.2.1"
},
"publishConfig": {
Expand Down
16 changes: 0 additions & 16 deletions packages/vaadin-app-layout/index.html
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions packages/vaadin-app-layout/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"src",
"theme"
],
"scripts": {
"dist": "rimraf dist && polymer analyze vaadin-* > analysis.json && rollup -c rollup.config.js && cp analysis.json dist"
},
"dependencies": {
"@polymer/polymer": "^3.0.0",
"@vaadin/vaadin-button": "^20.0.0-alpha1",
Expand All @@ -37,15 +34,10 @@
},
"devDependencies": {
"@esm-bundle/chai": "^4.1.5",
"@open-wc/rollup-plugin-html": "^1.2.5",
"@open-wc/testing-helpers": "^1.8.12",
"@polymer/iron-component-page": "^4.0.0",
"@polymer/iron-test-helpers": "^3.0.1",
"@vaadin/vaadin-icons": "^20.0.0-alpha1",
"@vaadin/vaadin-tabs": "^20.0.0-alpha1",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"sinon": "^9.2.1"
},
"publishConfig": {
Expand Down
12 changes: 0 additions & 12 deletions packages/vaadin-app-layout/rollup.config.js
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions packages/vaadin-avatar/index.html
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions packages/vaadin-avatar/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"src",
"theme"
],
"scripts": {
"dist": "rimraf dist && polymer analyze vaadin-* > analysis.json && rollup -c rollup.config.js && cp analysis.json dist"
},
"dependencies": {
"@polymer/iron-a11y-announcer": "^3.0.0",
"@polymer/iron-resizable-behavior": "^3.0.0",
Expand All @@ -41,13 +38,8 @@
},
"devDependencies": {
"@esm-bundle/chai": "^4.1.5",
"@open-wc/rollup-plugin-html": "^1.2.5",
"@open-wc/testing-helpers": "^1.8.12",
"@polymer/iron-component-page": "^4.0.0",
"@polymer/iron-test-helpers": "^3.0.0",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"sinon": "^9.2.1"
},
"publishConfig": {
Expand Down
12 changes: 0 additions & 12 deletions packages/vaadin-avatar/rollup.config.js
View file
Open in desktop

This file was deleted.

5 changes: 3 additions & 2 deletions packages/vaadin-avatar/src/vaadin-avatar-group-list-box.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,10 @@
import { ListBoxElement } from '@vaadin/vaadin-list-box/src/vaadin-list-box.js';

/**
* The vaadin-avatar-group-list-box element.
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
*
* @extends HTMLElement
* @extends ListBoxElement
* @private
*/
class AvatarGroupListBoxElement extends ListBoxElement {
static get is() {
Expand Down
12 changes: 3 additions & 9 deletions packages/vaadin-avatar/src/vaadin-avatar-group-overlay.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,10 @@ registerStyles(
);

/**
* The overlay element.
* An element used internally by `<vaadin-avatar-group>`. Not intended to be used separately.
*
* ### Styling
*
* See [`<vaadin-overlay>` documentation](https://github.com/vaadin/vaadin-overlay/blob/master/src/vaadin-overlay.html)
* for `<vaadin-avatar-group-overlay>` parts.
*
* See [ThemableMixin – how to apply styles for shadow parts](https://github.com/vaadin/vaadin-themable-mixin/wiki)
*
* @extends HTMLElement
* @extends OverlayElement
* @private
*/
class AvatarGroupOverlayElement extends OverlayElement {
static get is() {
Expand Down
8 changes: 8 additions & 0 deletions packages/vaadin-avatar/src/vaadin-avatar-group.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ import { AvatarGroupItem, AvatarGroupI18n } from './interfaces';
* `avatar` | Individual avatars
*
* See [Styling Components](https://vaadin.com/docs/v14/themes/styling-components.html) documentation.
*
* ### Internal components
*
* In addition to `<vaadin-avatar-group>` itself, the following internal
* components are themable:
*
* - `<vaadin-avatar-group-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
* - `<vaadin-avatar-group-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
*/
declare class AvatarGroupElement extends ElementMixin(ThemableMixin(HTMLElement)) {
readonly _avatars: HTMLElement[];
Expand Down
8 changes: 8 additions & 0 deletions packages/vaadin-avatar/src/vaadin-avatar-group.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,14 @@ const MINIMUM_DISPLAYED_AVATARS = 2;
*
* See [Styling Components](https://vaadin.com/docs/v14/themes/styling-components.html) documentation.
*
* ### Internal components
*
* In addition to `<vaadin-avatar-group>` itself, the following internal
* components are themable:
*
* - `<vaadin-avatar-group-list-box>` - has the same API as [`<vaadin-list-box>`](#/elements/vaadin-list-box).
* - `<vaadin-avatar-group-overlay>` - has the same API as [`<vaadin-overlay>`](#/elements/vaadin-overlay).
*
* @extends HTMLElement
* @mixes ElementMixin
* @mixes ThemableMixin
Expand Down
15 changes: 0 additions & 15 deletions packages/vaadin-board/index.html
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions packages/vaadin-board/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,9 +27,6 @@
"src",
"theme"
],
"scripts": {
"dist": "rimraf dist && polymer analyze vaadin-* > analysis.json && rollup -c rollup.config.js && cp analysis.json dist"
},
"dependencies": {
"@polymer/iron-resizable-behavior": "^3.0.0",
"@polymer/polymer": "^3.0.0",
Expand All @@ -38,12 +35,7 @@
},
"devDependencies": {
"@esm-bundle/chai": "^4.1.5",
"@open-wc/rollup-plugin-html": "^1.2.5",
"@open-wc/testing-helpers": "^1.8.12",
"@polymer/iron-component-page": "^4.0.0",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"sinon": "^9.2.1"
},
"publishConfig": {
Expand Down
12 changes: 0 additions & 12 deletions packages/vaadin-board/rollup.config.js
View file
Open in desktop

This file was deleted.

16 changes: 0 additions & 16 deletions packages/vaadin-button/index.html
View file
Open in desktop

This file was deleted.

8 changes: 0 additions & 8 deletions packages/vaadin-button/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,6 @@
"src",
"theme"
],
"scripts": {
"dist": "rimraf dist && polymer analyze vaadin-* > analysis.json && rollup -c rollup.config.js && cp analysis.json dist"
},
"dependencies": {
"@polymer/polymer": "^3.0.0",
"@vaadin/vaadin-control-state-mixin": "^20.0.0-alpha1",
Expand All @@ -37,13 +34,8 @@
},
"devDependencies": {
"@esm-bundle/chai": "^4.1.5",
"@open-wc/rollup-plugin-html": "^1.2.5",
"@polymer/iron-component-page": "^4.0.0",
"@polymer/iron-icon": "^3.0.0",
"@vaadin/testing-helpers": "^0.1.3",
"rimraf": "^3.0.2",
"rollup": "^2.34.1",
"rollup-plugin-terser": "^7.0.2",
"sinon": "^9.2.4"
},
"publishConfig": {
Expand Down
Loading