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
2 changes: 1 addition & 1 deletion packages/app-layout/src/vaadin-app-layout-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ export declare class AppLayoutMixinClass {
* just the individual properties you want to change.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* drawer: 'Drawer'
* }
Expand Down
2 changes: 1 addition & 1 deletion packages/app-layout/src/vaadin-app-layout-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ export const AppLayoutMixin = (superclass) =>
* just the individual properties you want to change.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* drawer: 'Drawer'
* }
Expand Down
16 changes: 8 additions & 8 deletions packages/app-layout/src/vaadin-app-layout.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -55,17 +55,17 @@ export type AppLayoutEventMap = AppLayoutCustomEventMap & HTMLElementEventMap;
* For best results, the component should be added to the root level of your application (i.e., as a direct child of `<body>`).
*
* The page should include a viewport meta tag which contains `viewport-fit=cover`, like the following:
* ```
* ```html
* <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
* ```
*
* This causes the viewport to be scaled to fill the device display.
* To ensure that important content is displayed, use the provided css variables.
* ```
* --safe-area-inset-top
* --safe-area-inset-right
* --safe-area-inset-bottom
* --safe-area-inset-left
* ```
* To ensure that important content is displayed, use the provided css variables:
*
* - `--safe-area-inset-top`
* - `--safe-area-inset-right`
* - `--safe-area-inset-bottom`
* - `--safe-area-inset-left`
*
* ### Styling
*
Expand Down
16 changes: 8 additions & 8 deletions packages/app-layout/src/vaadin-app-layout.js
Original file line number Diff line number Diff line change
Expand Up @@ -35,17 +35,17 @@ import { AppLayoutMixin } from './vaadin-app-layout-mixin.js';
* For best results, the component should be added to the root level of your application (i.e., as a direct child of `<body>`).
*
* The page should include a viewport meta tag which contains `viewport-fit=cover`, like the following:
* ```
* ```html
* <meta name="viewport" content="width=device-width, initial-scale=1, viewport-fit=cover">
* ```
*
* This causes the viewport to be scaled to fill the device display.
* To ensure that important content is displayed, use the provided css variables.
* ```
* --safe-area-inset-top
* --safe-area-inset-right
* --safe-area-inset-bottom
* --safe-area-inset-left
* ```
* To ensure that important content is displayed, use the provided css variables:
*
* - `--safe-area-inset-top`
* - `--safe-area-inset-right`
* - `--safe-area-inset-bottom`
* - `--safe-area-inset-left`
*
* ### Styling
*
Expand Down
2 changes: 1 addition & 1 deletion packages/avatar-group/src/vaadin-avatar-group-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ export declare class AvatarGroupMixinClass {
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Translation of the anonymous user avatar tooltip.
* anonymous: 'anonymous',
Expand Down
2 changes: 1 addition & 1 deletion packages/avatar-group/src/vaadin-avatar-group-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ export const AvatarGroupMixin = (superClass) =>
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Translation of the anonymous user avatar tooltip.
* anonymous: 'anonymous',
Expand Down
2 changes: 1 addition & 1 deletion packages/avatar/src/vaadin-avatar-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ export declare class AvatarMixinClass {
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Translation of the anonymous user avatar tooltip.
* anonymous: 'anonymous'
Expand Down
2 changes: 1 addition & 1 deletion packages/avatar/src/vaadin-avatar-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ export const AvatarMixin = (superClass) =>
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Translation of the anonymous user avatar tooltip.
* anonymous: 'anonymous'
Expand Down
2 changes: 1 addition & 1 deletion packages/button/src/vaadin-button.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ declare class Button extends ButtonMixin(ElementMixin(ThemableMixin(HTMLElement)
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* ```js
* // Set before any button is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true
* ```
Expand Down
2 changes: 1 addition & 1 deletion packages/button/src/vaadin-button.js
Original file line number Diff line number Diff line change
Expand Up @@ -71,7 +71,7 @@ class Button extends ButtonMixin(ElementMixin(ThemableMixin(PolylitMixin(LumoInj
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* ```js
* // Set before any button is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true
* ```
Expand Down
2 changes: 1 addition & 1 deletion packages/crud/src/vaadin-crud-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -232,7 +232,7 @@ export declare class CrudMixinClass<Item> {
*
* The object has the following JSON structure and default values:
*
* ```
* ```js
* {
* newItem: 'New item',
* editItem: 'Edit item',
Expand Down
2 changes: 1 addition & 1 deletion packages/crud/src/vaadin-crud-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,7 @@ export const CrudMixin = (superClass) =>
*
* The object has the following JSON structure and default values:
*
* ```
* ```js
* {
* newItem: 'New item',
* editItem: 'Edit item',
Expand Down
2 changes: 1 addition & 1 deletion packages/dashboard/src/vaadin-dashboard-section.js
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@ class DashboardSection extends DashboardItemMixin(
* `i18n` object with a custom one.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* selectSection: 'Select section for editing',
* remove: 'Remove',
Expand Down
2 changes: 1 addition & 1 deletion packages/dashboard/src/vaadin-dashboard-widget.js
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ class DashboardWidget extends DashboardItemMixin(
* `i18n` object with a custom one.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* selectWidget: 'Select widget for editing',
* remove: 'Remove',
Expand Down
2 changes: 1 addition & 1 deletion packages/dashboard/src/vaadin-dashboard.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -259,7 +259,7 @@ declare class Dashboard<TItem extends DashboardItem = DashboardItem> extends Das
* just the individual properties you want to change.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* selectSection: 'Select section for editing',
* selectWidget: 'Select widget for editing',
Expand Down
2 changes: 1 addition & 1 deletion packages/dashboard/src/vaadin-dashboard.js
Original file line number Diff line number Diff line change
Expand Up @@ -192,7 +192,7 @@ class Dashboard extends DashboardLayoutMixin(
* just the individual properties you want to change.
*
* The object has the following structure and default values:
* ```
* ```js
* {
* selectSection: 'Select section for editing',
* selectWidget: 'Select widget for editing',
Expand Down
2 changes: 1 addition & 1 deletion packages/date-picker/src/vaadin-date-picker-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -141,7 +141,7 @@ export declare class DatePickerMixinClass {
*
* The object has the following JSON structure and default values:
*
* ```
* ```js
* {
* // An array with the full names of months starting
* // with January.
Expand Down
2 changes: 1 addition & 1 deletion packages/date-picker/src/vaadin-date-picker-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -302,7 +302,7 @@ export const DatePickerMixin = (subclass) =>
*
* The object has the following JSON structure and default values:
*
* ```
* ```js
* {
* // An array with the full names of months starting
* // with January.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -150,7 +150,7 @@ export declare class DateTimePickerMixinClass {
*
* The object has the following structure and default values:
*
* ```
* ```js
* {
* // Accessible label to the date picker.
* // The property works in conjunction with label and accessibleName defined on the field.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -291,7 +291,7 @@ export const DateTimePickerMixin = (superClass) =>
*
* The object has the following structure and default values:
*
* ```
* ```js
* {
* // Accessible label to the date picker.
* // The property works in conjunction with label and accessibleName defined on the field.
Expand Down
2 changes: 1 addition & 1 deletion packages/form-layout/src/vaadin-form-item.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ import { FormItemMixin } from './vaadin-form-item-mixin.js';
*
* The `label-position` host attribute can be used to target the label on top state:
*
* ```
* ```css
* :host([label-position="top"]) {
* padding-top: 0.5rem;
* }
Expand Down
2 changes: 1 addition & 1 deletion packages/form-layout/src/vaadin-form-item.js
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ import { FormItemMixin } from './vaadin-form-item-mixin.js';
*
* The `label-position` host attribute can be used to target the label on top state:
*
* ```
* ```css
* :host([label-position="top"]) {
* padding-top: 0.5rem;
* }
Expand Down
2 changes: 1 addition & 1 deletion packages/form-layout/src/vaadin-form-layout-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ export declare class FormLayoutMixinClass {
* enabled explicitly via the `autoResponsive` property or implicitly
* if the following feature flag is set:
*
* ```
* ```js
* window.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true
* ```
*
Expand Down
2 changes: 1 addition & 1 deletion packages/form-layout/src/vaadin-form-layout-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ export const FormLayoutMixin = (superClass) =>
* enabled explicitly via the `autoResponsive` property or implicitly
* if the following feature flag is set:
*
* ```
* ```js
* window.Vaadin.featureFlags.defaultAutoResponsiveFormLayout = true
* ```
*
Expand Down
4 changes: 2 additions & 2 deletions packages/icon/src/vaadin-icon-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ export declare class IconMixinClass {
/**
* The SVG source to be loaded as the icon. It can be:
* - an URL to a file containing the icon
* - an URL in the format "/path/to/file.svg#objectID", where the "objectID" refers to an ID attribute contained
* - an URL in the format `/path/to/file.svg#objectID`, where the `objectID` refers to an ID attribute contained
* inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
* - a string in the format "data:image/svg+xml,<svg>...</svg>". You may need to use the "encodeURIComponent"
* - a string in the format `data:image/svg+xml,<svg>...</svg>`. You may need to use the `encodeURIComponent`
* function for the SVG content passed
*/
src: string | null;
Expand Down
4 changes: 2 additions & 2 deletions packages/icon/src/vaadin-icon-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -50,9 +50,9 @@ export const IconMixin = (superClass) =>
/**
* The SVG source to be loaded as the icon. It can be:
* - an URL to a file containing the icon
* - an URL in the format "/path/to/file.svg#objectID", where the "objectID" refers to an ID attribute contained
* - an URL in the format `/path/to/file.svg#objectID`, where the `objectID` refers to an ID attribute contained
* inside the SVG referenced by the path. Note that the file needs to follow the same-origin policy.
* - a string in the format "data:image/svg+xml,<svg>...</svg>". You may need to use the "encodeURIComponent"
* - a string in the format `data:image/svg+xml,<svg>...</svg>`. You may need to use the `encodeURIComponent`
* function for the SVG content passed
*
* @type {string}
Expand Down
2 changes: 1 addition & 1 deletion packages/login/src/vaadin-login-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export declare class LoginMixinClass {
* and `header` sections, `header` can be added to override `title` and `description` properties
* in `vaadin-login-overlay`):
*
* ```
* ```js
* {
* header: {
* title: 'App name',
Expand Down
2 changes: 1 addition & 1 deletion packages/login/src/vaadin-login-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -129,7 +129,7 @@ export const LoginMixin = (superClass) =>
* and `header` sections, `header` can be added to override `title` and `description` properties
* in `vaadin-login-overlay`):
*
* ```
* ```js
* {
* header: {
* title: 'App name',
Expand Down
4 changes: 2 additions & 2 deletions packages/menu-bar/src/vaadin-menu-bar-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ export declare class MenuBarMixinClass<TItem extends MenuBarItem = MenuBarItem>
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* ```js
* // Set before any menu bar is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true;
* ```
Expand All @@ -127,7 +127,7 @@ export declare class MenuBarMixinClass<TItem extends MenuBarItem = MenuBarItem>
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* moreOptions: 'More options'
* }
Expand Down
9 changes: 2 additions & 7 deletions packages/menu-bar/src/vaadin-menu-bar-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -136,12 +136,7 @@ export const MenuBarMixin = (superClass) =>
* which makes disabled buttons focusable and hoverable, while still
* preventing them from being triggered:
*
* ```
* // Set before any menu bar is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true;
* ```
*
* ```
* ```js
* // Set before any menu bar is attached to the DOM.
* window.Vaadin.featureFlags.accessibleDisabledButtons = true;
* ```
Expand Down Expand Up @@ -190,7 +185,7 @@ export const MenuBarMixin = (superClass) =>
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* moreOptions: 'More options'
* }
Expand Down
2 changes: 1 addition & 1 deletion packages/message-input/src/vaadin-message-input-mixin.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ export declare class MessageInputMixinClass {
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Used as the button label
* send: 'Send',
Expand Down
2 changes: 1 addition & 1 deletion packages/message-input/src/vaadin-message-input-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ export const MessageInputMixin = (superClass) =>
* just the individual properties you want to change.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Used as the button label
* send: 'Send',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ export declare class MultiSelectComboBoxMixinClass<TItem> {
* _i18n_ object or just the property you want to modify.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Screen reader announcement on clear button click.
* cleared: 'Selection cleared',
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -78,7 +78,7 @@ export const MultiSelectComboBoxMixin = (superClass) =>
* _i18n_ object or just the property you want to modify.
*
* The object has the following JSON structure and default values:
* ```
* ```js
* {
* // Screen reader announcement on clear button click.
* cleared: 'Selection cleared',
Expand Down
2 changes: 1 addition & 1 deletion packages/notification/src/vaadin-notification-mixin.js
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ export const NotificationMixin = (superClass) =>
* An options object can be passed to configure the notification.
* The options object has the following structure:
*
* ```
* ```ts
* {
* assertive?: boolean
* position?: string
Expand Down
2 changes: 1 addition & 1 deletion packages/notification/src/vaadin-notification.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ declare class Notification extends NotificationMixin(ElementMixin(HTMLElement))
* An options object can be passed to configure the notification.
* The options object has the following structure:
*
* ```
* ```ts
* {
* assertive?: boolean
* position?: string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ export declare class PasswordFieldMixinClass {
* An object with translated strings used for localization.
* It has the following structure and default values:
*
* ```
* ```js
* {
* // Translation of the reveal icon button accessible label
* reveal: 'Show password'
Expand Down
Loading