feat: Add consistent variant prop for design variant of buttons / chips
#6472
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
susnux
added
enhancement
susnux
requested review from
st3iny,
raimund-schluessler,
ShGKme and
Antreesy
Deprecate `type` for usage with the color variant. Also deprecate `nativeType` in favor of `type` and `variant`. Signed-off-by: Ferdinand Thiessen <[email protected]>
This is done to align with `NcButton`. Signed-off-by: Ferdinand Thiessen <[email protected]>
To align with `NcButton`. Signed-off-by: Ferdinand Thiessen <[email protected]>
…`type` prop To align with `NcButton`. Signed-off-by: Ferdinand Thiessen <[email protected]>
…e` prop To align with `NcButton`. Signed-off-by: Ferdinand Thiessen <[email protected]>
Signed-off-by: Ferdinand Thiessen <[email protected]>
Antreesy
reviewed
Jan 30, 2025
| variant: { | ||
| type: String, | ||
| validator(value) { | ||
| return ['primary', 'secondary', 'tertiary', 'tertiary-no-background', 'tertiary-on-primary', 'error', 'warning', 'success'].indexOf(value) !== -1 |
There was a problem hiding this comment.
I'd prefer using .includes(value) here.
Can we also keep available variants in one place (as const, or util like ValidateSlot) to not duplicate it everywhere? In case it's not a limited list of only primary, secondary, tertiary
| /** | ||
| * The button variant, see NcButton. | ||
| * | ||
| * @type {'primary'|'secondary'|'error'|'warning'|'success'} |
There was a problem hiding this comment.
'tertiary' is skipped here and above
There was a problem hiding this comment.
Fun fact: It is even in current version (and next) causing me in my apps having "invalid attribute 'tertiary'" 😅
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.
@nextcloud/vue v9breaking changes #6384 (comment)☑️ Resolves
Currently we need to wrap the native
typeprop of a button intonativeTypeofNcButton.This is confusing and we should never use names for props that are already attributes of the native HTML element.
The solution is to rename
typetovariant.To not make it breaking following is applied:
variantprop is added replacingtypenativeTypeis deprecated in favor oftypetypeallows both, the native button type and the color variantnativeTypeThe same is also applied for
NcDialogButtonandNcActions.NcChipalso referred to theNcButtonfor thetypeso this is also migrated the same way to make the wordingvariantconsistent.In a last step all components are refactored to use the new props instead.
🖼️ Screenshots
Nothing visually changed - if it does that's a regression 😨
🏁 Checklist
nextrequested with a Vue 3 upgrade