Skip to content

Add description for vis types #26243

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.

Sign up for GitHub

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

Merged
timroes merged 1 commit into from
Nov 27, 2018
Merged

Add description for vis types #26243

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions src/core_plugins/kibana/public/visualize/wizard/__snapshots__/new_vis_modal.test.tsx.snap
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -504,6 +504,7 @@ exports[`NewVisModal should render as expected 1`] = `
role="menu"
>
<EuiKeyPadMenuItemButton
aria-describedby="visTypeDescription-vis"
className="visNewVisDialog__type"
data-test-subj="visType-vis"
data-vis-stage="production"
Expand All @@ -523,6 +524,7 @@ exports[`NewVisModal should render as expected 1`] = `
onMouseLeave={[Function]}
>
<button
aria-describedby="visTypeDescription-vis"
className="euiKeyPadMenuItem visNewVisDialog__type"
data-test-subj="visType-vis"
data-vis-stage="production"
Expand Down Expand Up @@ -598,6 +600,7 @@ exports[`NewVisModal should render as expected 1`] = `
</button>
</EuiKeyPadMenuItemButton>
<EuiKeyPadMenuItemButton
aria-describedby="visTypeDescription-visWithSearch"
className="visNewVisDialog__type"
data-test-subj="visType-visWithSearch"
data-vis-stage="production"
Expand All @@ -617,6 +620,7 @@ exports[`NewVisModal should render as expected 1`] = `
onMouseLeave={[Function]}
>
<button
aria-describedby="visTypeDescription-visWithSearch"
className="euiKeyPadMenuItem visNewVisDialog__type"
data-test-subj="visType-visWithSearch"
data-vis-stage="production"
Expand Down
1 change: 1 addition & 0 deletions src/core_plugins/kibana/public/visualize/wizard/type_selection/type_selection.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -180,6 +180,7 @@ class TypeSelection extends React.Component<TypeSelectionProps, TypeSelectionSta
data-test-subj={`visType-${visType.name}`}
data-vis-stage={visType.stage}
disabled={isDisabled}
aria-describedby={`visTypeDescription-${visType.name}`}
{...stage}
>
<VisTypeIcon visType={visType} />
Expand Down
32 changes: 17 additions & 15 deletions src/core_plugins/kibana/public/visualize/wizard/type_selection/vis_help_text.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,21 +35,23 @@ export const VisHelpText = ({ visType }: VisHelpTextProps) => {
<h2>{visType.title}</h2>
</EuiTitle>
<EuiSpacer size="s" />
{visType.stage === 'experimental' && (
<React.Fragment>
<EuiText>
<em>
<FormattedMessage
id="kbn.visualize.newVisWizard.experimentalDescription"
defaultMessage="This visualization is experimental. The design and implementation
are less mature than stable visualizations and might be subject to change."
/>
</em>
</EuiText>
<EuiSpacer size="s" />
</React.Fragment>
)}
<EuiText>{visType.description}</EuiText>
<div id={`visTypeDescription-${visType.name}`}>
{visType.stage === 'experimental' && (
<React.Fragment>
<EuiText>
<em>
<FormattedMessage
id="kbn.visualize.newVisWizard.experimentalDescription"
defaultMessage="This visualization is experimental. The design and implementation
are less mature than stable visualizations and might be subject to change."
/>
</em>
</EuiText>
<EuiSpacer size="s" />
</React.Fragment>
)}
<EuiText>{visType.description}</EuiText>
</div>
</React.Fragment>
);
};