Skip to content

Commit 7a634a6

Browse files
authored
refactor: deprecate vaadin-board (#10030)
1 parent 4f5f88e commit 7a634a6

File tree

5 files changed

+23
-0
lines changed

5 files changed

+23
-0
lines changed

packages/board/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ A powerful and easy to use layout web component for building responsive views.
44

55
> ℹ️  A commercial Vaadin [subscription](https://vaadin.com/pricing) is required to use Board in your project.
66
7+
> [!WARNING]
8+
> `<vaadin-board>` is deprecated and will be removed in Vaadin 26. Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.
9+
710
[Documentation + Live Demo ↗](https://vaadin.com/docs/latest/components/board)
811

912
[![npm version](https://badgen.net/npm/v/@vaadin/board)](https://www.npmjs.com/package/@vaadin/board)

packages/board/src/vaadin-board-row.d.ts

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,9 @@ import { BoardRowMixin } from './vaadin-board-row-mixin.js';
4444
* ----------------|-------------|-------------
4545
* `--vaadin-board-width-small` | Determines the width where mode changes from `small` to `medium` | `600px`
4646
* `--vaadin-board-width-medium` | Determines the width where mode changes from `medium` to `large` | `960px`
47+
*
48+
* @deprecated `<vaadin-board-row>` is deprecated and will be removed in Vaadin 26.
49+
* Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.
4750
*/
4851
declare class BoardRow extends BoardRowMixin(ElementMixin(HTMLElement)) {}
4952

packages/board/src/vaadin-board-row.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,8 @@ import { BoardRowMixin } from './vaadin-board-row-mixin.js';
5252
* @extends HTMLElement
5353
* @mixes ElementMixin
5454
* @mixes BoardRowMixin
55+
* @deprecated `<vaadin-board-row>` is deprecated and will be removed in Vaadin 26.
56+
* Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.
5557
*/
5658
class BoardRow extends BoardRowMixin(ElementMixin(PolylitMixin(LitElement))) {
5759
static get is() {

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,9 @@ import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
2828
* </vaadin-board-row>
2929
* </vaadin-board>
3030
* ```
31+
*
32+
* @deprecated `<vaadin-board>` is deprecated and will be removed in Vaadin 26.
33+
* Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.
3134
*/
3235
declare class Board extends ElementMixin(HTMLElement) {
3336
/**

packages/board/src/vaadin-board.js

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@ import { css, html, LitElement } from 'lit';
1313
import { defineCustomElement } from '@vaadin/component-base/src/define.js';
1414
import { ElementMixin } from '@vaadin/component-base/src/element-mixin.js';
1515
import { PolylitMixin } from '@vaadin/component-base/src/polylit-mixin.js';
16+
import { issueWarning } from '@vaadin/component-base/src/warnings.js';
1617
import { BoardRow } from './vaadin-board-row.js';
1718

1819
/**
@@ -37,6 +38,8 @@ import { BoardRow } from './vaadin-board-row.js';
3738
* @customElement
3839
* @extends HTMLElement
3940
* @mixes ElementMixin
41+
* @deprecated `<vaadin-board>` is deprecated and will be removed in Vaadin 26.
42+
* Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.
4043
*/
4144
class Board extends ElementMixin(PolylitMixin(LitElement)) {
4245
static get is() {
@@ -59,6 +62,15 @@ class Board extends ElementMixin(PolylitMixin(LitElement)) {
5962
`;
6063
}
6164

65+
/** @protected */
66+
firstUpdated() {
67+
super.firstUpdated();
68+
69+
issueWarning(
70+
'`<vaadin-board>` is deprecated and will be removed in Vaadin 26. Consider using `<vaadin-dashboard>` or `<vaadin-dashboard-layout>` as an alternative.',
71+
);
72+
}
73+
6274
/** @protected */
6375
render() {
6476
return html`<slot></slot>`;

0 commit comments

Comments
 (0)