[Feature] Component Implementation - Button #34
There are no files selected for viewing
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
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,56 @@ | ||
| import { Meta, StoryObj } from '@storybook/react-native' | ||
| import { VAButton, VAButtonProps, VAButtonVariants } from './VAButton' | ||
| import { View } from 'react-native' | ||
| import React from 'react' | ||
|
|
||
| const meta: Meta<VAButtonProps> = { | ||
| title: 'VAButton', | ||
| component: VAButton, | ||
| argTypes: { | ||
| onPress: { | ||
| action: 'onPress event', | ||
| }, | ||
| }, | ||
|
|
||
| decorators: [ | ||
| (Story) => ( | ||
| <View | ||
| style={{ | ||
| flex: 1, | ||
| justifyContent: 'center', | ||
| alignItems: 'center', | ||
| }} | ||
| > | ||
| <Story /> | ||
| </View> | ||
| ), | ||
| ], | ||
| } | ||
|
|
||
| export default meta | ||
|
|
||
| type Story = StoryObj<VAButtonProps> | ||
|
|
||
| export const Primary: Story = { | ||
| storyName: 'Primary', | ||
| args: { | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| label: 'Button text', | ||
| a11yHint: 'My hint', | ||
| }, | ||
| } | ||
|
|
||
| export const Secondary: Story = { | ||
| storyName: 'Secondary', | ||
| args: { | ||
| buttonType: VAButtonVariants.Secondary, | ||
| label: 'Button text', | ||
| }, | ||
| } | ||
|
|
||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| export const Destructive: Story = { | ||
| storyName: 'Destructive', | ||
| args: { | ||
| buttonType: VAButtonVariants.Destructive, | ||
| label: 'Button text', | ||
| }, | ||
| } | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| import 'react-native' | ||
| import { RenderAPI, fireEvent, render } from '@testing-library/react-native' | ||
| import React from 'react' | ||
| // Note: test renderer must be required after react-native. | ||
| import 'jest-styled-components' | ||
| import { ReactTestInstance } from 'react-test-renderer' | ||
|
|
||
| import { VAButton } from './VAButton' | ||
|
|
||
| describe('VAButton', () => { | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| let component: RenderAPI | ||
| let testInstance: ReactTestInstance | ||
|
|
||
| const onPressSpy = jest.fn() | ||
|
|
||
| const initializeTestInstance = (): void => { | ||
| component = render(<VAButton label="Button text" onPress={onPressSpy} />) | ||
|
|
||
| testInstance = component.UNSAFE_root | ||
| } | ||
|
|
||
| beforeEach(() => { | ||
| initializeTestInstance() | ||
| }) | ||
|
|
||
| it('initializes correctly', async () => { | ||
| expect(component).toBeTruthy() | ||
| }) | ||
|
|
||
| it('should call onChange', async () => { | ||
| fireEvent.press(testInstance) | ||
| expect(onPressSpy).toBeCalled() | ||
| }) | ||
|
|
||
| it('should render label', async () => { | ||
| expect(component.findByText('Button text')).toBeTruthy() | ||
| }) | ||
| }) | ||
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,153 @@ | ||
| import * as DesignTokens from '@department-of-veterans-affairs/mobile-tokens' | ||
| import { | ||
| AccessibilityState, | ||
| Pressable, | ||
| PressableStateCallbackType, | ||
| Text, | ||
| TextStyle, | ||
| ViewStyle, | ||
| useColorScheme, | ||
| } from 'react-native' | ||
| import React from 'react' | ||
|
|
||
| import { webStorybookColorScheme } from '../../utils' | ||
|
|
||
| export enum VAButtonVariants { | ||
| Primary, | ||
| Secondary, | ||
| Destructive, | ||
| White, | ||
| } | ||
|
|
||
| export type VAButtonProps = { | ||
| /** text appearing in the button */ | ||
| label: string | ||
| /** function called when button is pressed */ | ||
| onPress: () => void | ||
| /** optional accessibility state */ | ||
| accessibilityState?: AccessibilityState | ||
| /** text to use as the accessibility hint */ | ||
| a11yHint?: string | ||
| /** specifies button styling type. defaults to primary if none specified */ | ||
| buttonType?: VAButtonVariants | ||
| /** a string value used to set the buttons testID/accessibility label */ | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| testID?: string | ||
| } | ||
|
|
||
| export const VAButton: React.FC<VAButtonProps> = ({ | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| label, | ||
| onPress, | ||
| accessibilityState, | ||
| a11yHint, | ||
| buttonType, | ||
| testID, | ||
| }) => { | ||
| const colorScheme = webStorybookColorScheme() || useColorScheme() | ||
| const isDestructive = buttonType === VAButtonVariants.Destructive | ||
| const isSecondary = buttonType === VAButtonVariants.Secondary | ||
| const isWhite = buttonType === VAButtonVariants.White | ||
|
|
||
| let bgColor: string, | ||
| bgColorPressed: string, | ||
| textColor: string, | ||
| textColorPressed: string, | ||
| borderColor: string = 'none', | ||
| borderColorPressed: string = 'none' | ||
|
|
||
| if (isWhite) { | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // This is a one-off, mobile app only variant. Colors are not tokenized | ||
| bgColor = DesignTokens.colorWhite | ||
| bgColorPressed = '#ffffffb3' | ||
| textColor = '#003e73' | ||
| } else if (colorScheme === 'light') { | ||
| bgColor = DesignTokens.colorUswdsSystemColorBlueVivid60 | ||
| bgColorPressed = DesignTokens.colorUswdsSystemColorBlueWarmVivid80 | ||
| textColor = DesignTokens.colorGrayLightest | ||
| textColorPressed = DesignTokens.colorGrayLightest | ||
|
|
||
| if (isDestructive) { | ||
| bgColor = DesignTokens.colorUswdsSystemColorRedVivid60 | ||
| bgColorPressed = DesignTokens.colorUswdsSystemColorRedVivid80 | ||
| } else if (isSecondary) { | ||
| bgColor = DesignTokens.colorWhite | ||
| bgColorPressed = DesignTokens.colorWhite | ||
| borderColor = DesignTokens.colorUswdsSystemColorBlueVivid60 | ||
| borderColorPressed = DesignTokens.colorUswdsSystemColorBlueWarmVivid80 | ||
| textColor = DesignTokens.colorUswdsSystemColorBlueVivid60 | ||
| textColorPressed = DesignTokens.colorUswdsSystemColorBlueWarmVivid80 | ||
| } | ||
| } else { | ||
| bgColor = DesignTokens.colorUswdsSystemColorBlueVivid30 | ||
| bgColorPressed = DesignTokens.colorPrimaryAltLightest | ||
| textColor = DesignTokens.colorBlack | ||
| textColorPressed = DesignTokens.colorBlack | ||
|
|
||
| if (isDestructive) { | ||
| bgColor = DesignTokens.colorUswdsSystemColorRedVivid40 | ||
| bgColorPressed = DesignTokens.colorSecondaryLightest | ||
| } else if (isSecondary) { | ||
| bgColor = DesignTokens.colorBlack | ||
| bgColorPressed = DesignTokens.colorBlack | ||
| borderColor = DesignTokens.colorUswdsSystemColorBlueVivid60 | ||
| borderColorPressed = DesignTokens.colorWhite | ||
| textColor = DesignTokens.colorUswdsSystemColorBlueVivid30 | ||
| textColorPressed = DesignTokens.colorWhite | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * Get button styling based on pressed state | ||
| * @param pressed - boolean for pressed state | ||
| * @returns ViewStyle for background | ||
| */ | ||
| const getBackgroundStyle = ({ | ||
|
There was a problem hiding this comment. Maybe fine to leave it be for now, but wonder if we should make a more generalized function to handle this behavior. Could also be used by the util function Basically a function that takes:
There was a problem hiding this comment. I didn't have time to implement something like this with me leaving for vacation, but I agree it could be useful as we're likely to be styling Pressable's in the future. I've created a ticket to work on this util function: https://github.com/department-of-veterans-affairs/va-mobile-app/issues/7240 |
||
| pressed, | ||
| }: PressableStateCallbackType): ViewStyle => ({ | ||
| alignSelf: 'stretch', | ||
| alignItems: 'center', | ||
| padding: 10, | ||
| backgroundColor: pressed ? bgColorPressed : bgColor, | ||
| borderRadius: 4, | ||
| borderWidth: isSecondary ? 2 : 0, | ||
| borderColor: isSecondary | ||
| ? pressed | ||
| ? borderColorPressed | ||
| : borderColor | ||
| : 'none', | ||
| }) | ||
|
|
||
| /** | ||
| * Get text styling based on pressed state | ||
| * @param pressed - boolean for pressed state | ||
| * @returns TextStyle for text | ||
| */ | ||
| const getTextStyle = (pressed: boolean): TextStyle => { | ||
| // TODO: Replace with typography tokens | ||
| const font: TextStyle = { | ||
| fontFamily: 'SourceSansPro-Bold', | ||
| fontSize: 20, | ||
| lineHeight: 30, | ||
| } | ||
|
|
||
| return { | ||
| ...font, | ||
| color: pressed ? textColorPressed : textColor, | ||
| } | ||
| } | ||
|
|
||
| return ( | ||
| <Pressable | ||
| style={getBackgroundStyle} | ||
| onPress={onPress} | ||
| accessibilityHint={a11yHint} | ||
| accessibilityRole="button" | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| accessible={true} | ||
| accessibilityState={accessibilityState || {}} | ||
narin marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| testID={testID || label} | ||
| > | ||
| {({ pressed }: PressableStateCallbackType) => ( | ||
| <Text style={getTextStyle(pressed)}>{label}</Text> | ||
| )} | ||
| </Pressable> | ||
| ) | ||
| } | ||
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
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
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
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
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
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just adding a preemptive note that should bump to 0.2.0 in the pre-merge publish.