-
Notifications
You must be signed in to change notification settings - Fork 27
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #156 from brionmario/feat-add-components
feat(react): add components
- Loading branch information
Showing
68 changed files
with
2,108 additions
and
34 deletions.
There are no files selected for viewing
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
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
46 changes: 46 additions & 0 deletions
46
packages/react/src/components/Checkbox/Checkbox.stories.mdx
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,46 @@ | ||
| import {ArgsTable, Source, Story, Canvas, Meta} from '@storybook/addon-docs'; | ||
| import dedent from 'ts-dedent'; | ||
| import StoryConfig from '../../../.storybook/story-config.ts'; | ||
| import Checkbox from './Checkbox.tsx'; | ||
|
|
||
| export const meta = { | ||
| component: Checkbox, | ||
| title: StoryConfig.Checkbox.hierarchy, | ||
| }; | ||
|
|
||
| <Meta title={meta.title} component={meta.component} /> | ||
|
|
||
| export const Template = args => <Checkbox {...args} />; | ||
|
|
||
| # Checkbox | ||
|
|
||
| - [Overview](#overview) | ||
| - [Props](#props) | ||
| - [Usage](#usage) | ||
|
|
||
| ## Overview | ||
|
|
||
| Checkboxes allow the user to select one or more items from a set. | ||
|
|
||
| <Canvas> | ||
| <Story | ||
| name="Overview" | ||
| > | ||
| {Template.bind({})} | ||
| </Story> | ||
| </Canvas> | ||
|
|
||
| ## Props | ||
|
|
||
| <ArgsTable story="Overview" /> | ||
|
|
||
| ## Usage | ||
|
|
||
| Import and use the `Checkbox` component in your components as follows. | ||
|
|
||
| <Source | ||
| language="jsx" | ||
| dark | ||
| format | ||
| code={dedent`import Checkbox from '@oxygen-ui/react/Checkbox';\n`} | ||
| /> |
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,43 @@ | ||
| /** | ||
| * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). | ||
| * | ||
| * WSO2 LLC. licenses this file to you under the Apache License, | ||
| * Version 2.0 (the "License"); you may not use this file except | ||
| * in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import MuiCheckbox, {CheckboxProps as MuiCheckboxProps} from '@mui/material/Checkbox'; | ||
| import clsx from 'clsx'; | ||
| import {forwardRef, ForwardRefExoticComponent, ReactElement, MutableRefObject} from 'react'; | ||
| import {WithWrapperProps} from '../../models'; | ||
| import {composeComponentDisplayName} from '../../utils'; | ||
|
|
||
| export type CheckboxProps = MuiCheckboxProps; | ||
|
|
||
| const COMPONENT_NAME: string = 'Checkbox'; | ||
|
|
||
| const Checkbox: ForwardRefExoticComponent<CheckboxProps> & WithWrapperProps = forwardRef( | ||
| (props: CheckboxProps, ref: MutableRefObject<HTMLButtonElement>): ReactElement => { | ||
| const {className, ...rest} = props; | ||
|
|
||
| const classes: string = clsx('oxygen-checkbox', className); | ||
|
|
||
| return <MuiCheckbox className={classes} {...rest} ref={ref} />; | ||
| }, | ||
| ) as ForwardRefExoticComponent<CheckboxProps> & WithWrapperProps; | ||
|
|
||
| Checkbox.displayName = composeComponentDisplayName(COMPONENT_NAME); | ||
| Checkbox.muiName = COMPONENT_NAME; | ||
| Checkbox.defaultProps = {}; | ||
|
|
||
| export default Checkbox; |
32 changes: 32 additions & 0 deletions
32
packages/react/src/components/Checkbox/__tests__/Checkbox.test.tsx
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,32 @@ | ||
| /** | ||
| * Copyright (c) 2023, WSO2 LLC. (https://www.wso2.com). All Rights Reserved. | ||
| * | ||
| * WSO2 LLC. licenses this file to you under the Apache License, | ||
| * Version 2.0 (the "License"); you may not use this file except | ||
| * in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
|
|
||
| import {render} from '@unit-testing'; | ||
| import Checkbox from '../Checkbox'; | ||
|
|
||
| describe('Checkbox', () => { | ||
| it('should render successfully', () => { | ||
| const {baseElement} = render(<Checkbox />); | ||
| expect(baseElement).toBeTruthy(); | ||
| }); | ||
|
|
||
| it('should match the snapshot', () => { | ||
| const {baseElement} = render(<Checkbox />); | ||
| expect(baseElement).toMatchSnapshot(); | ||
| }); | ||
| }); |
Oops, something went wrong.