Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add onPrimary variant to KeybindingHint #5414

Merged
merged 2 commits into from
Dec 11, 2024
+36 −7
Merged

Add onPrimary variant to KeybindingHint #5414

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9233a14
Add `onPrimary` variant to `KeybindingHint`
iansan5653 Dec 11, 2024
2ab4c4d
Create flat-sheep-look.md
iansan5653 Dec 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/flat-sheep-look.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@primer/react": minor
---

Add `onPrimary` `variant` to `KeybindingHint`
11 changes: 10 additions & 1 deletion packages/react/src/KeybindingHint/KeybindingHint.examples.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,16 @@ export const PrimaryButton: StoryObj<KeybindingHintProps> = {
Submit
</Button>
),
args: {keys: 'Mod+Enter', variant: 'onEmphasis'},
args: {keys: 'Mod+Enter', variant: 'onPrimary'},
}

export const DangerButton: StoryObj<KeybindingHintProps> = {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I didn't add an onDanger variant since danger buttons have a light resting background that works OK with the current design. Just added a story to demonstrate that

render: args => (
<Button variant="danger" trailingVisual={() => <KeybindingHint {...args} />}>
Delete
</Button>
),
args: {keys: 'Mod+Delete', variant: 'normal'},
}

export const ActionListExample: StoryObj<KeybindingHintProps> = {
Expand Down
11 changes: 10 additions & 1 deletion packages/react/src/KeybindingHint/KeybindingHint.features.stories.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,11 +22,20 @@ export const SequenceFull = {args: {keys: sequence, format: 'full'}}

export const OnEmphasis: StoryObj<KeybindingHintProps> = {
render: args => (
<Box sx={{backgroundColor: 'accent.fg', p: 3}}>
<Box sx={{backgroundColor: 'var(--bgColor-black)', p: 3}}>
<KeybindingHint {...args} />
</Box>
),
args: {keys: chord, variant: 'onEmphasis'},
}

export const OnPrimary: StoryObj<KeybindingHintProps> = {
render: args => (
<Box sx={{backgroundColor: 'var(--button-primary-bgColor-rest)', p: 3}}>
<KeybindingHint {...args} />
</Box>
),
args: {keys: chord, variant: 'onPrimary'},
}

export const Small = {args: {keys: chord, size: 'small'}}
12 changes: 9 additions & 3 deletions packages/react/src/KeybindingHint/components/Chord.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,14 +29,20 @@ const splitChord = (chord: string) =>
.map(k => k.toLowerCase())
.sort(compareLowercaseKeys)

const backgroundColors = {
normal: 'var(--bgColor-transparent)',
onEmphasis: 'var(--counter-bgColor-emphasis)',
onPrimary: 'var(--button-primary-bgColor-active)',
}

export const Chord = ({keys, format = 'condensed', variant = 'normal', size = 'normal'}: KeybindingHintProps) => (
<Text
sx={{
display: 'inline-flex',
bg: variant === 'onEmphasis' ? 'var(--counter-bgColor-emphasis)' : 'var(--bgColor-transparent)',
color: variant === 'onEmphasis' ? 'var(--fgColor-onEmphasis)' : 'var(--fgColor-muted)',
bg: backgroundColors[variant],
color: variant === 'normal' ? 'var(--fgColor-muted)' : 'var(--fgColor-onEmphasis)',
border: '1px solid',
borderColor: variant === 'onEmphasis' ? 'transparent' : 'var(--borderColor-default)',
borderColor: variant === 'normal' ? 'var(--borderColor-default)' : 'transparent',
borderRadius: size === 'small' ? 1 : 2,
fontWeight: 'normal',
fontFamily: 'normal',
Expand Down
4 changes: 2 additions & 2 deletions packages/react/src/KeybindingHint/props.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
export type KeybindingHintFormat = 'condensed' | 'full'

export type KeybindingHintVariant = 'normal' | 'onEmphasis'
export type KeybindingHintVariant = 'normal' | 'onEmphasis' | 'onPrimary'

export interface KeybindingHintProps {
/**
Expand All @@ -24,7 +24,7 @@ export interface KeybindingHintProps {
*/
format?: KeybindingHintFormat
/**
* Set to `onEmphasis` for display on emphasis colors.
* Set to `onEmphasis` for display on emphasis colors, and `onPrimary` for display on primary buttons.
*/
variant?: KeybindingHintVariant
/**
Expand Down
Loading