AutoSizeInput: Move to @grafana/ui (#48811)

* AutoSizeInput: Move to @grafana/ui

* Update packages/grafana-ui/src/components/AutoSizeInput/AutoSizeInput.mdx

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Update packages/grafana-ui/src/components/AutoSizeInput/AutoSizeInput.mdx

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Update packages/grafana-ui/src/components/AutoSizeInput/AutoSizeInput.mdx

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Fix linter error

* Update packages/grafana-ui/src/components/AutoSizeInput/AutoSizeInput.mdx

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Update packages/grafana-ui/src/components/AutoSizeInput/AutoSizeInput.mdx

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>

* Move AutoSizeInput to Input folder

* Use iconOptions in storybook

Co-authored-by: JitaC <70489351+achatterjee-grafana@users.noreply.github.com>
This commit is contained in:
Ivana Huckova 2022-05-30 10:46:33 +02:00 committed by GitHub
parent 47a3ddd968
commit 5f6b23e45a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
11 changed files with 151 additions and 20 deletions

View File

@ -0,0 +1,37 @@
import { Props, Preview } from '@storybook/addon-docs/blocks';
import { AutoSizeInput } from './AutoSizeInput';
import { Field } from '../Forms/Field';
import { Icon } from '../Icon/Icon';
# AutoSizeInput
You can use it or regular text input. When used, AutoSizeInput resizes itself to the current content. For an array of data or tree-structured data, consider using `Select` or `Cascader` respectively.
## Prefix and suffix
To add more context to the input, you can add either text or an icon before or after the input using the `prefix` and `suffix`. Here are some examples for you to try in the canvas!
```jsx
<AutoSizeInput prefix={<Icon name="search" />} />
```
<Preview>
<AutoSizeInput prefix={<Icon name="search" />} />
</Preview>
## Usage in forms with Field
Use `AutoSizeInput`with the`Field`component to get labels and descriptions. Also, you can use`AutoSizeInput`with the`required`attribute for validation. See the`Field` component for more information.
```jsx
<Field label="Important information" description="This information is very important, so you really need to fill it in">
<AutoSizeInput name="importantInput" required />
</Field>
```
<Preview>
<Field label="Important information!" description="Please enter the relevant information.">
<AutoSizeInput name="importantInput" required />
</Field>
</Preview>
<Props of={AutoSizeInput} />

View File

@ -0,0 +1,100 @@
import { Story, Meta } from '@storybook/react';
import React from 'react';
import { Icon, Button, AutoSizeInput } from '@grafana/ui';
import { IconName } from '../../types';
import { iconOptions } from '../../utils/storybook/knobs';
import { withCenteredStory } from '../../utils/storybook/withCenteredStory';
import mdx from './AutoSizeInput.mdx';
const icons: { [key: string]: string | undefined } = { ...iconOptions };
Object.keys(icons).forEach((key) => {
icons[key] = `icon-${icons[key]}`;
});
const prefixSuffixOpts = {
Text: '$',
...icons,
};
export default {
title: 'Forms/Input/AutoSizeInput',
component: AutoSizeInput,
decorators: [withCenteredStory],
parameters: {
docs: {
page: mdx,
},
controls: {
exclude: ['prefix', 'suffix', 'addonBefore', 'addonAfter'],
},
},
args: {
type: 'text',
width: 40,
prefixVisible: '',
suffixVisible: '',
invalid: false,
loading: false,
},
argTypes: {
prefixVisible: {
control: {
type: 'select',
options: prefixSuffixOpts,
},
},
suffixVisible: {
control: {
type: 'select',
options: prefixSuffixOpts,
},
},
type: {
control: {
type: 'select',
options: ['text', 'number', 'password'],
},
},
minWidth: { control: { type: 'range', min: 10, max: 200, step: 10 } },
},
} as Meta;
export const Simple: Story = (args) => {
const addonAfter = <Button variant="secondary">Load</Button>;
const addonBefore = <div style={{ display: 'flex', alignItems: 'center', padding: '5px' }}>AutoSizeInput</div>;
const prefix = args.prefixVisible;
const suffix = args.suffixVisible;
let prefixEl: any = prefix;
if (prefix && prefix.match(/icon-/g)) {
prefixEl = <Icon name={prefix.replace(/icon-/g, '') as IconName} />;
}
let suffixEl: any = suffix;
if (suffix && suffix.match(/icon-/g)) {
suffixEl = <Icon name={suffix.replace(/icon-/g, '') as IconName} />;
}
return (
<AutoSizeInput
disabled={args.disabled}
prefix={prefixEl}
invalid={args.invalid}
width={args.width}
suffix={suffixEl}
loading={args.loading}
addonBefore={args.before && addonBefore}
addonAfter={args.after && addonAfter}
type={args.type}
placeholder={args.placeholder}
minWidth={args.minWidth}
/>
);
};
Simple.args = {
disabled: false,
before: false,
after: false,
placeholder: 'Enter your name here...',
};

View File

@ -3,16 +3,13 @@ import React from 'react';
import { AutoSizeInput } from './AutoSizeInput';
jest.mock('@grafana/ui', () => {
const original = jest.requireActual('@grafana/ui');
const mockedUi = { ...original };
jest.mock('../../utils/measureText', () => {
// Mocking measureText
mockedUi.measureText = (text: string, fontSize: number) => {
const measureText = (text: string, fontSize: number) => {
return { width: text.length * fontSize };
};
return mockedUi;
return { measureText };
});
describe('AutoSizeInput', () => {

View File

@ -1,7 +1,9 @@
import React, { useEffect } from 'react';
import { Input, measureText } from '@grafana/ui';
import { Props as InputProps } from '@grafana/ui/src/components/Input/Input';
import { measureText } from '../../utils/measureText';
import { Input, Props as InputProps } from './Input';
export interface Props extends InputProps {
/** Sets the min-width to a multiple of 8px. Default value is 10*/
minWidth?: number;

View File

@ -218,6 +218,7 @@ export { RadioButtonGroup } from './Forms/RadioButtonGroup/RadioButtonGroup';
export { RadioButtonList } from './Forms/RadioButtonList/RadioButtonList';
export { Input, getInputStyles } from './Input/Input';
export { AutoSizeInput } from './Input/AutoSizeInput';
export { FilterInput } from './FilterInput/FilterInput';
export { FormInputSize } from './Forms/types';

View File

@ -2,8 +2,7 @@ import React from 'react';
import { SelectableValue } from '@grafana/data';
import { EditorRow, EditorField } from '@grafana/experimental';
import { RadioButtonGroup, Select } from '@grafana/ui';
import { AutoSizeInput } from 'app/plugins/datasource/prometheus/querybuilder/shared/AutoSizeInput';
import { RadioButtonGroup, Select, AutoSizeInput } from '@grafana/ui';
import { QueryOptionGroup } from 'app/plugins/datasource/prometheus/querybuilder/shared/QueryOptionGroup';
import { preprocessMaxLines, queryTypeOptions, RESOLUTION_OPTIONS } from '../../components/LokiOptionFields';

View File

@ -3,8 +3,7 @@ import React from 'react';
import { GrafanaTheme2, toOption } from '@grafana/data';
import { EditorRows, FlexItem } from '@grafana/experimental';
import { IconButton, Select, useStyles2 } from '@grafana/ui';
import { AutoSizeInput } from 'app/plugins/datasource/prometheus/querybuilder/shared/AutoSizeInput';
import { AutoSizeInput, IconButton, Select, useStyles2 } from '@grafana/ui';
import { LokiDatasource } from '../../datasource';
import { binaryScalarDefs } from '../binaryScalarOperations';

View File

@ -3,11 +3,10 @@ import React from 'react';
import { GrafanaTheme2, toOption } from '@grafana/data';
import { EditorRows, FlexItem } from '@grafana/experimental';
import { IconButton, Select, useStyles2 } from '@grafana/ui';
import { AutoSizeInput, IconButton, Select, useStyles2 } from '@grafana/ui';
import { PrometheusDatasource } from '../../datasource';
import { binaryScalarDefs } from '../binaryScalarOperations';
import { AutoSizeInput } from '../shared/AutoSizeInput';
import { PromVisualQueryBinary } from '../types';
import { PromQueryBuilder } from './PromQueryBuilder';

View File

@ -2,12 +2,11 @@ import React, { SyntheticEvent } from 'react';
import { CoreApp, SelectableValue } from '@grafana/data';
import { EditorRow, EditorField, EditorSwitch } from '@grafana/experimental';
import { RadioButtonGroup, Select } from '@grafana/ui';
import { AutoSizeInput, RadioButtonGroup, Select } from '@grafana/ui';
import { getQueryTypeChangeHandler, getQueryTypeOptions } from '../../components/PromExploreExtraField';
import { FORMAT_OPTIONS, INTERVAL_FACTOR_OPTIONS } from '../../components/PromQueryEditor';
import { PromQuery } from '../../types';
import { AutoSizeInput } from '../shared/AutoSizeInput';
import { QueryOptionGroup } from '../shared/QueryOptionGroup';
import { getLegendModeLabel, PromQueryLegendEditor } from './PromQueryLegendEditor';

View File

@ -2,10 +2,9 @@ import React, { useRef } from 'react';
import { SelectableValue } from '@grafana/data';
import { EditorField } from '@grafana/experimental';
import { Select } from '@grafana/ui';
import { Select, AutoSizeInput } from '@grafana/ui';
import { LegendFormatMode } from '../../types';
import { AutoSizeInput } from '../shared/AutoSizeInput';
export interface Props {
legendFormat: string | undefined;

View File

@ -1,11 +1,10 @@
import React, { ComponentType } from 'react';
import { SelectableValue, toOption } from '@grafana/data';
import { Checkbox, Select } from '@grafana/ui';
import { AutoSizeInput, Checkbox, Select } from '@grafana/ui';
import { QueryBuilderOperationParamDef, QueryBuilderOperationParamEditorProps } from '../shared/types';
import { AutoSizeInput } from './AutoSizeInput';
import { getOperationParamId } from './operationUtils';
export function getOperationParamEditor(