-
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.
feat(react): add
InputAdornment
component
- Loading branch information
1 parent
f419b03
commit c336485
Showing
7 changed files
with
169 additions
and
0 deletions.
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
48 changes: 48 additions & 0 deletions
48
packages/react/src/components/InputAdornment/InputAdornment.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,48 @@ | ||
import {ArgsTable, Source, Story, Canvas, Meta} from '@storybook/addon-docs'; | ||
import dedent from 'ts-dedent'; | ||
import StoryConfig from '../../../.storybook/story-config.ts'; | ||
import InputAdornment from './InputAdornment.tsx'; | ||
import TextField from '../TextField/TextField.tsx'; | ||
import LinkTo from '@storybook/addon-links/react'; | ||
|
||
export const meta = { | ||
component: InputAdornment, | ||
title: StoryConfig.InputAdornment.hierarchy, | ||
}; | ||
|
||
<Meta title={meta.title} component={meta.component} /> | ||
|
||
export const Template = args => <InputAdornment {...args} />; | ||
|
||
# Input Adornment | ||
|
||
- [Overview](#overview) | ||
- [Props](#props) | ||
- [Usage](#usage) | ||
|
||
## Overview | ||
|
||
Display a prefix, a suffix, or an action to an input. For instance, you can use an icon button to hide or reveal the password. | ||
|
||
For examples and details on the usage of this React component, visit the component demo pages: | ||
|
||
- <LinkTo kind="?path=/docs/inputs-text-field--overview">Text Field</LinkTo> | ||
|
||
## Props | ||
|
||
<ArgsTable /> | ||
|
||
## Usage | ||
|
||
Import and use the `InputAdornment` component in your components as follows. | ||
|
||
<Source | ||
language="jsx" | ||
dark | ||
format | ||
code={dedent` | ||
import InputAdornment from '@oxygen-ui/react/InputAdornment';\n | ||
function Demo() { | ||
return <InputAdornment />; | ||
}`} | ||
/> |
45 changes: 45 additions & 0 deletions
45
packages/react/src/components/InputAdornment/InputAdornment.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,45 @@ | ||
/** | ||
* 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 MuiInputAdornment, {InputAdornmentProps as MuiInputAdornmentProps} from '@mui/material/InputAdornment'; | ||
import clsx from 'clsx'; | ||
import {ElementType, FC, ReactElement} from 'react'; | ||
import {WithWrapperProps} from '../../models'; | ||
import {composeComponentDisplayName} from '../../utils'; | ||
|
||
export type InputAdornmentProps<C extends ElementType = ElementType> = { | ||
component?: C; | ||
} & Omit<MuiInputAdornmentProps<C>, 'component'>; | ||
|
||
const COMPONENT_NAME: string = 'InputAdornment'; | ||
|
||
const InputAdornment: FC<InputAdornmentProps> & WithWrapperProps = <C extends ElementType>( | ||
props: InputAdornmentProps<C>, | ||
): ReactElement => { | ||
const {className, position, ...rest} = props; | ||
|
||
const classes: string = clsx('oxygen-input-adornment', className); | ||
|
||
return <MuiInputAdornment position={position} className={classes} {...rest} />; | ||
}; | ||
|
||
InputAdornment.displayName = composeComponentDisplayName(COMPONENT_NAME); | ||
InputAdornment.muiName = COMPONENT_NAME; | ||
InputAdornment.defaultProps = {}; | ||
|
||
export default InputAdornment; |
32 changes: 32 additions & 0 deletions
32
packages/react/src/components/InputAdornment/__test__/InputAdornment.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 InputAdornment from '../InputAdornment'; | ||
|
||
describe('InputAdornment', () => { | ||
it('should render successfully', () => { | ||
const {baseElement} = render(<InputAdornment position="start" />); | ||
expect(baseElement).toBeTruthy(); | ||
}); | ||
|
||
it('should match the snapshot', () => { | ||
const {baseElement} = render(<InputAdornment position="start" />); | ||
expect(baseElement).toMatchSnapshot(); | ||
}); | ||
}); |
17 changes: 17 additions & 0 deletions
17
...s/react/src/components/InputAdornment/__test__/__snapshots__/InputAdornment.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,17 @@ | ||
// Jest Snapshot v1, https://goo.gl/fbAQLP | ||
|
||
exports[`InputAdornment should match the snapshot 1`] = ` | ||
<body> | ||
<div> | ||
<div | ||
class="MuiInputAdornment-root MuiInputAdornment-positionStart oxygen-input-adornment css-1ju4t5z-MuiInputAdornment-root" | ||
> | ||
<span | ||
class="notranslate" | ||
> | ||
| ||
</span> | ||
</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 './InputAdornment'; | ||
export type {InputAdornmentProps} from './InputAdornment'; |
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