Add a TierIndicator component #2956
Open
+198
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
🦋 Changeset detectedLatest commit: 0517055 The changes in this PR will be included in the next version bump. This PR includes changesets to release 2 packages
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
Size Change: +8 B (0%) Total Size: 707 kB
ℹ️ View Unchanged
|
sirineJ
force-pushed
the
tier-indicator
branch
from
e526380 to
e5cd185
Compare
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #2956 +/- ##
==========================================
+ Coverage 87.60% 87.61% +0.01%
==========================================
Files 228 229 +1
Lines 13058 13069 +11
Branches 1760 1761 +1
==========================================
+ Hits 11440 11451 +11
Misses 1561 1561
Partials 57 57
|
sirineJ
force-pushed
the
tier-indicator
branch
from
e5cd185 to
063aa2c
Compare
connor-baer
changed the title
connor-baer
reviewed
Feb 27, 2025
sirineJ
force-pushed
the
tier-indicator
branch
from
1d9b35c to
58e93f4
Compare
sirineJ
force-pushed
the
tier-indicator
branch
from
58e93f4 to
efc628a
Compare
sirineJ
force-pushed
the
tier-indicator
branch
from
efc628a to
5c06d0c
Compare
sirineJ
force-pushed
the
tier-indicator
branch
from
5c06d0c to
521f341
Compare
sirineJ
force-pushed
the
tier-indicator
branch
from
7594e08 to
0517055
Compare
connor-baer
reviewed
Feb 28, 2025
| @@ -0,0 +1,5 @@ | |||
| <svg xmlns="http://www.w3.org/2000/svg" width="36" height="16" fill="none" viewBox="0 0 36 16"> | |||
| <g clip-path="url(#plus_tier_16_svg__clip0_11228_178)"> | |||
There was a problem hiding this comment.
The referenced clip-path element doesn't exist, which makes me think it's not needed.
| @@ -0,0 +1,5 @@ | |||
| <svg xmlns="http://www.w3.org/2000/svg" width="63" height="32" fill="none" viewBox="0 0 63 32"> | |||
| <g clip-path="url(#plus_tier_32_svg__clip0_11228_194)"> | |||
There was a problem hiding this comment.
We'll need to remember to bump @sumup-oss/circuit-ui's peer dependency range of @sumup-oss/icons, since the TierIndicator component relies on the new icons.
|
|
||
| import { TierIndicator } from './TierIndicator.js'; | ||
|
|
||
| describe('TierIndicator', () => { |
There was a problem hiding this comment.
The test for a custom class name is missing.
| /** | ||
| * The tier name. | ||
| */ | ||
| variant: 'Plus'; |
There was a problem hiding this comment.
Suggested change
| variant: 'Plus'; | |
| variant: 'plus'; |
| */ | ||
| size?: 's' | 'm' | 'l'; | ||
| } | ||
| const sizeMap: Record<string, (typeof SIZES)[number]> = { |
There was a problem hiding this comment.
Why not simply:
Suggested change
| const sizeMap: Record<string, (typeof SIZES)[number]> = { | |
| const sizeMap: Record<string, '16' | '24' | '32'> = { |
There was a problem hiding this comment.
Alternatively you could remove the type and annotate it with as const, which would also ensure that the keys match the size prop.
| variant: 'Plus'; | ||
| /** | ||
| * Choose from 3 sizes. | ||
| * @default `m`. |
There was a problem hiding this comment.
Suggested change
| * @default `m`. | |
| * @default 'm'. |
| }; | ||
|
|
||
| export const TierIndicator = forwardRef<SVGSVGElement, TierIndicatorProps>( | ||
| ({ size = 'm', ...props }, ref) => ( |
There was a problem hiding this comment.
We need to filter out the variant prop here since it's not a valid SVG attribute.
Suggested change
| ({ size = 'm', ...props }, ref) => ( | |
| ({ size = 'm', variant, ...props }, ref) => ( |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Addresses DSYS-955
Purpose
Create a new component to highlight features that are behind a paywall or provided by a certain tier.
Approach and changes
Create a TierIndicator component to highlight paid plans. For now, this component only accepts the "Plus" tier but can be extended in the future if necessary. The component is built by placing a Headline component in front an svg shape of the indicator, and comes in three sizes: s, m and l.
Definition of done