Skip to content

Commit d7d8a8e

Browse files
web-padawanArtur-
web-padawan
and
Artur-
authored
feat: add initial badge component implementation (#11131)
Co-authored-by: Artur Signell <artur@vaadin.com>
1 parent ae21846 commit d7d8a8e

19 files changed

Lines changed: 742 additions & 2 deletions

‎dev/badge.html‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<!doctype html>
2+
<html lang="en">
3+
<head>
4+
<meta charset="UTF-8" />
5+
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
6+
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
7+
<title>Badge</title>
8+
<script type="module" src="./common.js"></script>
9+
<script>
10+
window.Vaadin ??= {};
11+
window.Vaadin.featureFlags ??= {};
12+
window.Vaadin.featureFlags.badgeComponent = true;
13+
</script>
14+
<script type="module">
15+
import '@vaadin/badge';
16+
import '@vaadin/icon';
17+
import '@vaadin/icons';
18+
</script>
19+
</head>
20+
21+
<body>
22+
<section class="section">
23+
<h2 class="heading">Default</h2>
24+
<vaadin-badge>Default</vaadin-badge>
25+
</section>
26+
27+
<section class="section">
28+
<h2 class="heading">Icon</h2>
29+
<vaadin-badge>
30+
<vaadin-icon slot="icon" icon="vaadin:check"></vaadin-icon>
31+
<span>Completed</span>
32+
</vaadin-badge>
33+
<vaadin-badge>
34+
<vaadin-icon slot="icon" icon="vaadin:check"></vaadin-icon>
35+
</vaadin-badge>
36+
</section>
37+
</body>
38+
</html>

‎packages/badge/LICENSE‎

Lines changed: 190 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,190 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
Copyright 2026 Vaadin Ltd.
179+
180+
Licensed under the Apache License, Version 2.0 (the "License");
181+
you may not use this file except in compliance with the License.
182+
You may obtain a copy of the License at
183+
184+
http://www.apache.org/licenses/LICENSE-2.0
185+
186+
Unless required by applicable law or agreed to in writing, software
187+
distributed under the License is distributed on an "AS IS" BASIS,
188+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
189+
See the License for the specific language governing permissions and
190+
limitations under the License.

‎packages/badge/README.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
# @vaadin/badge
2+
3+
A web component for displaying badges with various theme variants.
4+
5+
[Documentation + Live Demo ↗](https://vaadin.com/docs/latest/components/badge)
6+
7+
[![npm version](https://badgen.net/npm/v/@vaadin/badge)](https://www.npmjs.com/package/@vaadin/badge)
8+
9+
> ⚠️ This component is experimental and the API may change. In order to use it, enable the feature flag by setting `window.Vaadin.featureFlags.badgeComponent = true`.
10+
11+
```html
12+
<vaadin-badge>Badge</vaadin-badge>
13+
<vaadin-badge theme="primary">Primary</vaadin-badge>
14+
<vaadin-badge theme="success">Success</vaadin-badge>
15+
<vaadin-badge theme="error">Error</vaadin-badge>
16+
<vaadin-badge theme="warning">Warning</vaadin-badge>
17+
<vaadin-badge theme="contrast">Contrast</vaadin-badge>
18+
```
19+
20+
## Installation
21+
22+
Install the component:
23+
24+
```sh
25+
npm i @vaadin/badge
26+
```
27+
28+
Once installed, import the component in your application:
29+
30+
```js
31+
import '@vaadin/badge';
32+
```
33+
34+
## Contributing
35+
36+
Read the [contributing guide](https://vaadin.com/docs/latest/contributing) to learn about our development process, how to propose bugfixes and improvements, and how to test your changes to Vaadin components.
37+
38+
## License
39+
40+
Apache License 2.0
41+
42+
Vaadin collects usage statistics at development time to improve this product.
43+
For details and to opt-out, see https://github.com/vaadin/vaadin-usage-statistics.

‎packages/badge/package.json‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{
2+
"name": "@vaadin/badge",
3+
"version": "25.1.0-alpha7",
4+
"publishConfig": {
5+
"access": "public"
6+
},
7+
"description": "vaadin-badge",
8+
"license": "Apache-2.0",
9+
"repository": {
10+
"type": "git",
11+
"url": "https://github.com/vaadin/web-components.git",
12+
"directory": "packages/badge"
13+
},
14+
"author": "Vaadin Ltd",
15+
"homepage": "https://vaadin.com/components",
16+
"bugs": {
17+
"url": "https://github.com/vaadin/web-components/issues"
18+
},
19+
"main": "vaadin-badge.js",
20+
"module": "vaadin-badge.js",
21+
"type": "module",
22+
"files": [
23+
"src",
24+
"vaadin-*.d.ts",
25+
"vaadin-*.js",
26+
"custom-elements.json",
27+
"web-types.json",
28+
"web-types.lit.json"
29+
],
30+
"keywords": [
31+
"Vaadin",
32+
"badge",
33+
"web-components",
34+
"web-component"
35+
],
36+
"dependencies": {
37+
"@vaadin/component-base": "25.1.0-alpha7",
38+
"@vaadin/vaadin-themable-mixin": "25.1.0-alpha7",
39+
"lit": "^3.0.0"
40+
},
41+
"devDependencies": {
42+
"@vaadin/aura": "25.1.0-alpha7",
43+
"@vaadin/chai-plugins": "25.1.0-alpha7",
44+
"@vaadin/icon": "25.1.0-alpha7",
45+
"@vaadin/icons": "25.1.0-alpha7",
46+
"@vaadin/test-runner-commands": "25.1.0-alpha7",
47+
"@vaadin/testing-helpers": "^2.0.0",
48+
"@vaadin/vaadin-lumo-styles": "25.1.0-alpha7",
49+
"sinon": "^21.0.0"
50+
},
51+
"customElements": "custom-elements.json",
52+
"web-types": [
53+
"web-types.json",
54+
"web-types.lit.json"
55+
]
56+
}

‎packages/badge/src/styles/vaadin-badge-base-styles.d.ts‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
/**
2+
* @license
3+
* Copyright (c) 2026 - 2026 Vaadin Ltd.
4+
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
5+
*/
6+
import type { CSSResult } from 'lit';
7+
8+
export const badgeStyles: CSSResult;

‎packages/badge/src/styles/vaadin-badge-base-styles.js‎

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
/**
2+
* @license
3+
* Copyright (c) 2026 - 2026 Vaadin Ltd.
4+
* This program is available under Apache License Version 2.0, available at https://vaadin.com/license/
5+
*/
6+
import '@vaadin/component-base/src/styles/style-props.js';
7+
import { css } from 'lit';
8+
9+
export const badgeStyles = css`
10+
:host {
11+
display: inline-flex;
12+
align-items: center;
13+
justify-content: center;
14+
box-sizing: border-box;
15+
vertical-align: baseline;
16+
gap: var(--vaadin-badge-gap, 0.25em);
17+
padding: var(
18+
--vaadin-badge-padding,
19+
var(--vaadin-padding-xs) calc(var(--vaadin-padding-s) + var(--vaadin-badge-border-radius, 0.25em) / 4)
20+
);
21+
font-family: var(--vaadin-badge-font-family, inherit);
22+
font-size: var(--vaadin-badge-font-size, 0.875em);
23+
font-weight: var(--vaadin-badge-font-weight, 500);
24+
line-height: var(--vaadin-badge-line-height, 1);
25+
color: var(--vaadin-badge-text-color, var(--vaadin-text-color));
26+
background: var(--vaadin-badge-background, var(--vaadin-background-container));
27+
border-radius: var(--vaadin-badge-border-radius, var(--vaadin-radius-l));
28+
flex-shrink: 0;
29+
}
30+
31+
:host([hidden]) {
32+
display: none !important;
33+
}
34+
35+
:host([has-icon]:not([has-content])) {
36+
padding: var(--vaadin-padding-xs);
37+
border-radius: 50%;
38+
}
39+
40+
@media (forced-colors: active) {
41+
:host {
42+
border: 1px solid;
43+
}
44+
}
45+
`;

0 commit comments

Comments
 (0)