-
Notifications
You must be signed in to change notification settings - Fork 27
feat: add snackbar component #497
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
6dac422
feat: add snackbar component
AlanFnz 22b2404
feat: add export
AlanFnz e033379
chore: add tests
AlanFnz 625a7e8
fix: container padding
AlanFnz d2bf409
feat: add dismiss button as part of the component
AlanFnz 0c1d3f2
fix: use icon button
AlanFnz 0b64656
fix: remove cursor prop from component
AlanFnz File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,24 @@ | ||
| import React from 'react'; | ||
| import { fireEvent, render, screen } from '@testing-library/react'; | ||
| import { Snackbar } from './Snackbar'; | ||
|
|
||
| test('renders the Snackbar component with children', () => { | ||
| render( | ||
| <Snackbar> | ||
| <span>Test Snackbar</span> | ||
| </Snackbar> | ||
| ); | ||
| expect(screen.getByText('Test Snackbar')).toBeInTheDocument(); | ||
| }); | ||
|
|
||
| test('renders the dismiss button when hasDismissButton is true and calls onDismiss when clicked', () => { | ||
| const onDismiss = jest.fn(); | ||
| render( | ||
| <Snackbar hasDismissButton onDismiss={onDismiss}> | ||
| <span>Test Snackbar</span> | ||
| </Snackbar> | ||
| ); | ||
| const dismissButton = screen.getByTestId('snackbar-close-icon'); | ||
| fireEvent.click(dismissButton); | ||
| expect(onDismiss).toHaveBeenCalledTimes(1); | ||
| }); |
This file contains hidden or 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,59 @@ | ||
| import React, { ReactNode, type ReactElement } from 'react'; | ||
| import styled from 'styled-components'; | ||
| import { SpaceProps, LayoutProps, PositionProps, FlexboxProps } from 'styled-system'; | ||
|
|
||
| import { get } from '../../../utils/experimental/themeGet'; | ||
| import { getSemanticValue } from '../../../essentials/experimental'; | ||
| import { textStyles } from '../Text/Text'; | ||
| import { XCrossIcon } from '../../../icons'; | ||
| import { IconButton } from '../IconButton/IconButton'; | ||
|
|
||
| const Container = styled.div` | ||
| position: relative; | ||
| justify-content: space-between; | ||
|
|
||
| border: none; | ||
| outline: none; | ||
| border-radius: ${get('radii.4')}; | ||
| padding: ${get('space.3')} ${get('space.4')}; | ||
| color: ${getSemanticValue('inverse-on-surface')}; | ||
| background-color: ${getSemanticValue('inverse-surface')}; | ||
|
|
||
| display: inline-flex; | ||
| align-items: center; | ||
| gap: ${get('space.1')}; | ||
|
|
||
| ${textStyles.variants.body2} | ||
| `; | ||
|
|
||
| const DismissButton = styled(IconButton)` | ||
| height: unset; | ||
| width: unset; | ||
| padding: 0; | ||
| `; | ||
|
|
||
| interface SnackbarProps extends SpaceProps, LayoutProps, PositionProps, FlexboxProps { | ||
| children: ReactNode; | ||
| hasDismissButton?: boolean; | ||
| onDismiss?: () => void; | ||
| } | ||
|
|
||
| const Snackbar = ({ | ||
| children, | ||
| hasDismissButton = false, | ||
| onDismiss = null, | ||
| ...restProps | ||
| }: SnackbarProps): ReactElement => ( | ||
| <Container {...restProps}> | ||
| {children} | ||
| {hasDismissButton && ( | ||
| <DismissButton | ||
| data-testid="snackbar-close-icon" | ||
| Icon={() => <XCrossIcon size={24} color={getSemanticValue('inverse-on-surface')} />} | ||
| onPress={onDismiss} | ||
| /> | ||
| )} | ||
| </Container> | ||
| ); | ||
|
|
||
| export { Snackbar, SnackbarProps }; | ||
31 changes: 31 additions & 0 deletions
31
src/components/experimental/Snackbar/docs/Snackbar.stories.tsx
This file contains hidden or 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,31 @@ | ||
| import type { Meta, StoryObj } from '@storybook/react'; | ||
| import { action } from '@storybook/addon-actions'; | ||
|
|
||
| import { Snackbar } from '../Snackbar'; | ||
|
|
||
| const meta: Meta = { | ||
| title: 'Experimental/Components/Snackbar', | ||
| component: Snackbar, | ||
| parameters: { | ||
| layout: 'centered' | ||
| }, | ||
| argTypes: {}, | ||
| args: { | ||
| children: 'Booking successfully cancelled', | ||
| hasDismissButton: false, | ||
| onDismiss: null | ||
| } | ||
| }; | ||
|
|
||
| export default meta; | ||
|
|
||
| type Story = StoryObj<typeof Snackbar>; | ||
|
|
||
| export const Default: Story = {}; | ||
|
|
||
| export const WithDismissIcon: Story = { | ||
| args: { | ||
| hasDismissButton: true, | ||
| onDismiss: action('Remove snackbar') | ||
| } | ||
| }; |
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.