-
Notifications
You must be signed in to change notification settings - Fork 27
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
feat(react): add Select
component
#59
Merged
Merged
Changes from all commits
Commits
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 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,69 @@ | ||
import {ArgsTable, Source, Story, Canvas, Meta} from '@storybook/addon-docs'; | ||
import {useArgs} from '@storybook/client-api'; | ||
import dedent from 'ts-dedent'; | ||
import StoryConfig from '../../../.storybook/story-config.ts'; | ||
import Select from './Select.tsx'; | ||
import MenuItem from '../MenuItem'; | ||
|
||
export const meta = { | ||
component: Select, | ||
title: StoryConfig.Select.hierarchy, | ||
}; | ||
|
||
<Meta title={meta.title} component={meta.component} /> | ||
|
||
export const Template = args => { | ||
const [{open, anchor, onChange, label}, updateArgs] = useArgs(); | ||
return ( | ||
<Select label="Select WSO2 Product" defaultValue='Asgardeo' onChange={() => updateArgs({value: anchor})} {...args}> | ||
{['Asgardeo', 'Identity Server', 'Choreo', 'APIM'].map(anchor => ( | ||
<MenuItem key={anchor} value={anchor}> | ||
{anchor} | ||
</MenuItem> | ||
))} | ||
</Select> | ||
) | ||
}; | ||
|
||
# Select | ||
|
||
- [Overview](#overview) | ||
- [Props](#props) | ||
- [Usage](#usage) | ||
|
||
## Overview | ||
|
||
The `Select` component is used to create a select input. | ||
|
||
<Canvas> | ||
<Story | ||
name="Overview" | ||
> | ||
{Template.bind({})} | ||
</Story> | ||
</Canvas> | ||
|
||
## Props | ||
|
||
<ArgsTable story="Overview" /> | ||
|
||
## Usage | ||
|
||
Import and use the `Select` component in your components as follows. | ||
|
||
<Source | ||
language="jsx" | ||
dark | ||
format | ||
code={dedent` | ||
import Select from '@oxygen-ui/react/Select';\n | ||
function Demo() { | ||
return ( | ||
<Select> | ||
<MenuItem value={10}>Ten</MenuItem> | ||
<MenuItem value={20}>Twenty</MenuItem> | ||
<MenuItem value={30}>Thirty</MenuItem> | ||
</Select> | ||
); | ||
}`} | ||
/> |
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,57 @@ | ||
/** | ||
* 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 MuiSelect, {SelectProps as MuiSelectProps} from '@mui/material/Select'; | ||
import clsx from 'clsx'; | ||
import {forwardRef, ForwardRefExoticComponent, MutableRefObject, ReactElement} from 'react'; | ||
import {WithWrapperProps} from '../../models'; | ||
import {composeComponentDisplayName} from '../../utils'; | ||
import Box from '../Box'; | ||
import InputLabel, {InputLabelProps as MuiInputLabelProps} from '../InputLabel'; | ||
import './select.scss'; | ||
|
||
export interface SelectProps extends MuiSelectProps { | ||
InputLabelProps?: MuiInputLabelProps; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Are we making this prop optional here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. yes. the props already passed satisfies the basic functionality |
||
} | ||
|
||
const COMPONENT_NAME: string = 'Select'; | ||
|
||
const Select: ForwardRefExoticComponent<SelectProps> & WithWrapperProps = forwardRef( | ||
(props: SelectProps, ref: MutableRefObject<HTMLDivElement>): ReactElement => { | ||
const {className, InputLabelProps, label, id, ...rest} = props; | ||
|
||
const classes: string = clsx('oxygen-select', className); | ||
|
||
return ( | ||
<Box className={classes}> | ||
{label && ( | ||
<InputLabel id={id} {...InputLabelProps}> | ||
{label} | ||
</InputLabel> | ||
)} | ||
<MuiSelect ref={ref} labelId={id} {...rest} /> | ||
</Box> | ||
); | ||
}, | ||
) as ForwardRefExoticComponent<SelectProps> & WithWrapperProps; | ||
|
||
Select.displayName = composeComponentDisplayName(COMPONENT_NAME); | ||
Select.muiName = COMPONENT_NAME; | ||
Select.defaultProps = {}; | ||
|
||
export default Select; |
32 changes: 32 additions & 0 deletions
32
packages/react/src/components/Select/__tests__/Select.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 Select from '../Select'; | ||
|
||
describe('Select', () => { | ||
it('should render successfully', () => { | ||
const {baseElement} = render(<Select />); | ||
expect(baseElement).toBeTruthy(); | ||
}); | ||
|
||
it('should match the snapshot', () => { | ||
const {baseElement} = render(<Select />); | ||
expect(baseElement).toMatchSnapshot(); | ||
}); | ||
}); |
60 changes: 60 additions & 0 deletions
60
packages/react/src/components/Select/__tests__/__snapshots__/Select.test.tsx.snap
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,60 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`Select should match the snapshot 1`] = ` | ||
<body> | ||
<div> | ||
<div | ||
class="oxygen-box oxygen-select MuiBox-root css-0" | ||
> | ||
<div | ||
class="MuiInputBase-root MuiOutlinedInput-root MuiInputBase-colorPrimary css-saqlya-MuiInputBase-root-MuiOutlinedInput-root-MuiSelect-root" | ||
> | ||
<div | ||
aria-expanded="false" | ||
aria-haspopup="listbox" | ||
class="MuiSelect-select MuiSelect-outlined MuiInputBase-input MuiOutlinedInput-input css-1d3lhbp-MuiSelect-select-MuiInputBase-input-MuiOutlinedInput-input" | ||
role="button" | ||
tabindex="0" | ||
> | ||
<span | ||
class="notranslate" | ||
> | ||
| ||
</span> | ||
</div> | ||
<input | ||
aria-hidden="true" | ||
class="MuiSelect-nativeInput css-yf8vq0-MuiSelect-nativeInput" | ||
tabindex="-1" | ||
value="" | ||
/> | ||
<svg | ||
aria-hidden="true" | ||
class="MuiSvgIcon-root MuiSvgIcon-fontSizeMedium MuiSelect-icon MuiSelect-iconOutlined css-j9wse9-MuiSvgIcon-root-MuiSelect-icon" | ||
data-testid="ArrowDropDownIcon" | ||
focusable="false" | ||
viewBox="0 0 24 24" | ||
> | ||
<path | ||
d="M7 10l5 5 5-5z" | ||
/> | ||
</svg> | ||
<fieldset | ||
aria-hidden="true" | ||
class="MuiOutlinedInput-notchedOutline css-116asjz-MuiOutlinedInput-notchedOutline" | ||
> | ||
<legend | ||
class="css-ihdtdm" | ||
> | ||
<span | ||
class="notranslate" | ||
> | ||
| ||
</span> | ||
</legend> | ||
</fieldset> | ||
</div> | ||
</div> | ||
</div> | ||
</body> | ||
`; |
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,20 @@ | ||
/** | ||
* 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. | ||
*/ | ||
|
||
export {default} from './Select'; | ||
export type {SelectProps} from './Select'; |
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,21 @@ | ||
/** | ||
* 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. | ||
*/ | ||
|
||
.oxygen-select { | ||
/* Add Styles */ | ||
} |
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.
Is this component polymorphic?
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.
There is no
component
prop to make this component take the form of a different Component element.