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

fix(component): SHIPPING-1526 adds description to Select & MultiSelect #378

Merged
merged 1 commit into from
Apr 24, 2020
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
3 changes: 2 additions & 1 deletion packages/big-design/src/components/MultiSelect/types.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { Placement } from '@popperjs/core';
import { RefObject } from 'react';
import React, { RefObject } from 'react';

import { InputProps } from '../Input';
import { SelectAction, SelectOption } from '../Select';

interface BaseSelect extends Omit<React.HTMLAttributes<HTMLInputElement>, 'children'> {
action?: SelectAction;
description?: React.ReactChild;
disabled?: boolean;
error?: InputProps['error'];
filterable?: boolean;
Expand Down
3 changes: 2 additions & 1 deletion packages/big-design/src/components/Select/types.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import { Placement } from '@popperjs/core';
import { RefObject } from 'react';
import React, { RefObject } from 'react';

import { InputProps } from '../Input';
import { ListItemProps } from '../List/Item';

interface BaseSelect extends Omit<React.HTMLAttributes<HTMLInputElement>, 'children'> {
action?: SelectAction;
description?: React.ReactChild;
disabled?: boolean;
error?: InputProps['error'];
filterable?: boolean;
Expand Down
11 changes: 10 additions & 1 deletion packages/docs/PropTables/MultiSelectPropTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@ import React from 'react';
import { Code, NextLink, Prop, PropTable, PropTableWrapper } from '../components';

const selectProps: Prop[] = [
{ name: 'action', types: 'SelectAction', description: 'Action option displayed at the end of the list.' },
{
name: 'action',
types: 'SelectAction',
description: 'Action option displayed at the end of the list.',
},
{
name: 'description',
types: 'string | FormControlDescription',
description: 'Append a description to the select field.',
},
{
name: 'disabled',
defaultValue: 'false',
Expand Down
11 changes: 10 additions & 1 deletion packages/docs/PropTables/SelectPropTable.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,16 @@ import React from 'react';
import { Code, NextLink, Prop, PropTable, PropTableWrapper } from '../components';

const selectProps: Prop[] = [
{ name: 'action', types: 'SelectAction', description: 'Action option displayed at the end of the list.' },
{
name: 'action',
types: 'SelectAction',
description: 'Action option displayed at the end of the list.',
},
{
name: 'description',
types: 'string | FormControlDescription',
description: 'Append a description to the select field.',
},
{
name: 'disabled',
defaultValue: 'false',
Expand Down