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.

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 AlphaSpinner component #2237

Merged
merged 8 commits into from
May 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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/sweet-knives-divide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@channel.io/bezier-react": patch
---

Add `AlphaSpinner` component
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
import React from 'react'

import { type Meta, type StoryFn } from '@storybook/react'

import { Spinner } from './Spinner'
import { type SpinnerProps } from './Spinner.types'

const meta: Meta<typeof Spinner> = {
component: Spinner,
}

export default meta

const Template: StoryFn<SpinnerProps> = ({ ...args }) => <Spinner {...args} />

export const Primary = {
render: Template,

args: {
size: 'm',
variant: 'secondary',
},
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
@use '../../styles/mixins/dimension';

@keyframes rotate {
0% {
transform: rotate(0deg);
}

100% {
transform: rotate(360deg);
}
}

.Spinner {
Copy link
Contributor

Choose a reason for hiding this comment

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

깔끔하네요 👍

--b-spinner-size: initial;
--b-spinner-track-color: initial;
--b-spinner-indicator-color: initial;
--b-spinner-stroke-width: initial;
--b-spinner-stroke-dasharray: initial;

@include dimension.square(var(--b-spinner-size));

display: inline-flex;
animation: rotate 1s linear infinite;

& .track {
fill: none;
stroke: var(--b-spinner-track-color);
stroke-linecap: round;
stroke-width: var(--b-spinner-stroke-width);
}

& .indicator {
fill: none;
stroke: var(--b-spinner-indicator-color);
stroke-dasharray: var(--b-spinner-stroke-dasharray);
stroke-linecap: round;
stroke-width: var(--b-spinner-stroke-width);
}

&:where(.size-s) {
--b-spinner-size: 28px;
--b-spinner-stroke-width: 4px;
--b-spinner-stroke-dasharray: 40 9999;
}

&:where(.size-m) {
--b-spinner-size: 50px;
--b-spinner-stroke-width: 6px;
--b-spinner-stroke-dasharray: 60 9999;
}

&:where(.variant-primary) {
--b-spinner-track-color: var(--alpha-color-primary-bg-lightest);
--b-spinner-indicator-color: var(--alpha-color-fg-blue-normal);
}

&:where(.variant-secondary) {
--b-spinner-track-color: var(--alpha-color-bg-black-light);
--b-spinner-indicator-color: var(--alpha-color-fg-black-light);
}

&:where(.variant-on-overlay) {
--b-spinner-track-color: var(--alpha-color-bg-absolute-white-lightest);
--b-spinner-indicator-color: var(--alpha-color-fg-absolute-white-light);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
import React from 'react'

import { render } from '~/src/utils/test'

import { SPINNER_TEST_ID, Spinner } from './Spinner'

describe('Spinner >', () => {
const renderSpinner = (props?: React.ComponentProps<typeof Spinner>) =>
render(<Spinner {...props} />)

it('should render', () => {
const { getByTestId } = renderSpinner()
const renderedSpinner = getByTestId(SPINNER_TEST_ID)
expect(renderedSpinner).toBeInTheDocument()
})

it('should render as a span element by default', () => {
const { getByTestId } = renderSpinner()
const renderedSpinner = getByTestId(SPINNER_TEST_ID)
expect(renderedSpinner.tagName).toBe('SPAN')
})

it('should forward ref', () => {
const ref = React.createRef<HTMLDivElement>()
renderSpinner({ ref })
expect(ref.current).toBeInTheDocument()
})

it('should receive size', () => {
const { getByTestId } = renderSpinner({ size: 'm' })
const renderedSpinner = getByTestId(SPINNER_TEST_ID)
expect(renderedSpinner).toHaveClass('size-m')
})
})
50 changes: 50 additions & 0 deletions packages/bezier-react/src/components/AlphaSpinner/Spinner.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
import React, { forwardRef } from 'react'

import classNames from 'classnames'

import { type SpinnerProps } from './Spinner.types'

import styles from './Spinner.module.scss'

export const SPINNER_TEST_ID = 'bezier-spinner'

export const Spinner = forwardRef<HTMLSpanElement, SpinnerProps>(
function Spinner(
{ className, size, variant = 'secondary', ...rest },
forwardedRef
) {
return (
<span
className={classNames(
styles.Spinner,
size && styles[`size-${size}`],
styles[`variant-${variant}`]
)}
ref={forwardedRef}
data-testid={SPINNER_TEST_ID}
{...rest}
>
<svg
xmlns="http://www.w3.org/2000/svg"
viewBox="0 0 16 16"
>
<circle
cx="8"
cy="8"
r="7"
className={styles.track}
vectorEffect="non-scaling-stroke"
/>

<circle
cx="8"
cy="8"
r="7"
className={styles.indicator}
vectorEffect="non-scaling-stroke"
/>
</svg>
</span>
)
}
)
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
import {
type BezierComponentProps,
type ColorProps,
type SizeProps,
} from '~/src/types/props'

type SpinnerSize = 's' | 'm'

interface SpinnerOwnProps {
/**
* The style variant of Spinner.
* @default 'secondary'
*/
variant?: 'primary' | 'secondary' | 'on-overlay'
}

export interface SpinnerProps
extends Omit<BezierComponentProps<'span'>, keyof ColorProps>,
SizeProps<SpinnerSize>,
ColorProps,
SpinnerOwnProps {}
2 changes: 2 additions & 0 deletions packages/bezier-react/src/components/AlphaSpinner/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
export { Spinner as AlphaSpinner } from './Spinner'
export { type SpinnerProps as AlphaSpinnerProps } from './Spinner.types'
1 change: 1 addition & 0 deletions packages/bezier-react/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ export * from '~/src/components/AlphaDialogPrimitive'
export * from '~/src/components/AlphaFloatingButton'
export * from '~/src/components/AlphaFloatingIconButton'
export * from '~/src/components/AlphaIconButton'
export * from '~/src/components/AlphaSpinner'
export * from '~/src/components/AlphaTooltipPrimitive'
export * from '~/src/components/AppProvider'
export * from '~/src/components/AutoFocus'
Expand Down
Loading