Skip to content

Commit 782fba6

Browse files
authored
docs: deprecate overlayRole property in dialog and popover (#9880)
1 parent 7c92595 commit 782fba6

File tree

4 files changed

+4
-0
lines changed

4 files changed

+4
-0
lines changed

packages/dialog/src/vaadin-dialog-base-mixin.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,7 @@ export declare class DialogBaseMixinClass {
3636
* The `role` attribute value to be set on the dialog. Defaults to "dialog".
3737
*
3838
* @attr {string} overlay-role
39+
* @deprecated Use standard `role` attribute on the dialog instead
3940
*/
4041
overlayRole: string;
4142

packages/dialog/src/vaadin-dialog-base-mixin.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,6 +80,7 @@ export const DialogBaseMixin = (superClass) =>
8080
* The `role` attribute value to be set on the dialog. Defaults to "dialog".
8181
*
8282
* @attr {string} overlay-role
83+
* @deprecated Use standard `role` attribute on the dialog instead
8384
*/
8485
overlayRole: {
8586
type: String,

packages/popover/src/vaadin-popover.d.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -163,6 +163,7 @@ declare class Popover extends PopoverPositionMixin(
163163
* The `role` attribute value to be set on the overlay.
164164
*
165165
* @attr {string} overlay-role
166+
* @deprecated Use standard `role` attribute on the popover instead
166167
*/
167168
overlayRole: string;
168169

packages/popover/src/vaadin-popover.js

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -329,6 +329,7 @@ class Popover extends PopoverPositionMixin(
329329
* The `role` attribute value to be set on the overlay.
330330
*
331331
* @attr {string} overlay-role
332+
* @deprecated Use standard `role` attribute on the popover instead
332333
*/
333334
overlayRole: {
334335
type: String,

0 commit comments

Comments
 (0)