Skip to content

Commit

Permalink
[Index Management] Update the columns width in the index templates an…
Browse files Browse the repository at this point in the history
…d component templates tables (elastic#175337)

## Summary

Fixes elastic#174946 

This PR tries to improve the readability of the index templates and
component templates lists by setting the columns with text information
to be wider and to not truncate the text. The badges in the name columns
are also set to `inline` which makes the word breaking in the columns
better imho. See screenshots with before and after on a smaller screen
(just before the tables switch from rows to a mobile view).

### Screenshots
#### Index templates
Before
<img width="719" alt="Screenshot 2024-01-24 at 18 41 15"
src="https://github.com/elastic/kibana/assets/6585477/2e4e5df2-ae49-48c4-bbeb-28fa2dd86405">


After
<img width="711" alt="Screenshot 2024-01-24 at 18 40 37"
src="https://github.com/elastic/kibana/assets/6585477/39bc524f-d092-491b-b3f9-ffedd39c6fe5">



#### Component templates
Before
<img width="716" alt="Screenshot 2024-01-24 at 18 41 23"
src="https://github.com/elastic/kibana/assets/6585477/7a6f58bf-0478-4c88-a9d2-49b79c6acf60">


After
<img width="718" alt="Screenshot 2024-01-24 at 18 40 47"
src="https://github.com/elastic/kibana/assets/6585477/c08701a5-96e9-4f18-8eb7-49719e3eec6f">



### Checklist

Delete any items that are not applicable to this PR.

- [ ] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
- [ ]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [ ] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios
- [ ] [Flaky Test
Runner](https://ci-stats.kibana.dev/trigger_flaky_test_runner/1) was
used on any tests changed
- [ ] Any UI touched in this PR is usable by keyboard only (learn more
about [keyboard accessibility](https://webaim.org/techniques/keyboard/))
- [ ] Any UI touched in this PR does not create any new axe failures
(run axe in browser:
[FF](https://addons.mozilla.org/en-US/firefox/addon/axe-devtools/),
[Chrome](https://chrome.google.com/webstore/detail/axe-web-accessibility-tes/lhdoppojpmngadmnindnejefpokejbdd?hl=en-US))
- [ ] If a plugin configuration key changed, check if it needs to be
allowlisted in the cloud and added to the [docker
list](https://github.com/elastic/kibana/blob/main/src/dev/build/tasks/os_packages/docker_generator/resources/base/bin/kibana-docker)
- [ ] This renders correctly on smaller devices using a responsive
layout. (You can test this [in your
browser](https://www.browserstack.com/guide/responsive-testing-on-local-server))
- [ ] This was checked for [cross-browser
compatibility](https://www.elastic.co/support/matrix#matrix_browsers)


### Risk Matrix

Delete this section if it is not applicable to this PR.

Before closing this PR, invite QA, stakeholders, and other developers to
identify risks that should be tested prior to the change/feature
release.

When forming the risk matrix, consider some of the following examples
and how they may potentially impact the change:

| Risk | Probability | Severity | Mitigation/Notes |

|---------------------------|-------------|----------|-------------------------|
| Multiple Spaces&mdash;unexpected behavior in non-default Kibana Space.
| Low | High | Integration tests will verify that all features are still
supported in non-default Kibana Space and when user switches between
spaces. |
| Multiple nodes&mdash;Elasticsearch polling might have race conditions
when multiple Kibana nodes are polling for the same tasks. | High | Low
| Tasks are idempotent, so executing them multiple times will not result
in logical error, but will degrade performance. To test for this case we
add plenty of unit tests around this logic and document manual testing
procedure. |
| Code should gracefully handle cases when feature X or plugin Y are
disabled. | Medium | High | Unit tests will verify that any feature flag
or plugin combination still results in our service operational. |
| [See more potential risk
examples](https://github.com/elastic/kibana/blob/main/RISK_MATRIX.mdx) |


### For maintainers

- [ ] This was checked for breaking API changes and was [labeled
appropriately](https://www.elastic.co/guide/en/kibana/master/contributing.html#kibana-release-notes-process)
  • Loading branch information
yuliacech authored and CoenWarmer committed Feb 15, 2024
1 parent ffd3aee commit 3562f1e
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 10 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,7 @@ export const ComponentTable: FunctionComponent<Props> = ({
const [selection, setSelection] = useState<ComponentTemplateListItem[]>([]);

const tableProps: EuiInMemoryTableProps<ComponentTemplateListItem> = {
tableLayout: 'auto',
itemId: 'name',
isSelectable: true,
'data-test-subj': 'componentTemplatesTable',
Expand Down Expand Up @@ -154,9 +155,9 @@ export const ComponentTable: FunctionComponent<Props> = ({
defaultMessage: 'Name',
}),
sortable: true,
width: '20%',
width: '45%',
render: (name: string, item: ComponentTemplateListItem) => (
<>
<span>
<EuiLink
{...reactRouterNavigate(
history,
Expand All @@ -171,15 +172,15 @@ export const ComponentTable: FunctionComponent<Props> = ({
</EuiLink>
{item.isManaged && (
<>
&nbsp;
{' '}
<EuiBadge color="hollow" data-test-subj="isManagedBadge">
{i18n.translate('xpack.idxMgmt.componentTemplatesList.table.managedBadgeLabel', {
defaultMessage: 'Managed',
})}
</EuiBadge>
</>
)}
</>
</span>
),
},
{
Expand Down Expand Up @@ -211,6 +212,7 @@ export const ComponentTable: FunctionComponent<Props> = ({
defaultMessage: 'Mappings',
}),
truncateText: true,
align: 'center',
sortable: true,
render: (hasMappings: boolean) => (hasMappings ? <EuiIcon type="check" /> : null),
},
Expand All @@ -220,6 +222,7 @@ export const ComponentTable: FunctionComponent<Props> = ({
defaultMessage: 'Settings',
}),
truncateText: true,
align: 'center',
sortable: true,
render: (hasSettings: boolean) => (hasSettings ? <EuiIcon type="check" /> : null),
},
Expand All @@ -229,6 +232,7 @@ export const ComponentTable: FunctionComponent<Props> = ({
defaultMessage: 'Aliases',
}),
truncateText: true,
align: 'center',
sortable: true,
render: (hasAliases: boolean) => (hasAliases ? <EuiIcon type="check" /> : null),
},
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,21 @@ export const TemplateTable: React.FunctionComponent<Props> = ({
name: i18n.translate('xpack.idxMgmt.templateList.table.nameColumnTitle', {
defaultMessage: 'Name',
}),
truncateText: true,
sortable: true,
width: '30%',
render: (name: TemplateListItem['name'], item: TemplateListItem) => {
return (
<>
<span>
<EuiLink
{...reactRouterNavigate(history, getTemplateDetailsLink(name), () =>
uiMetricService.trackMetric(METRIC_TYPE.CLICK, UIM_TEMPLATE_SHOW_DETAILS_CLICK)
)}
data-test-subj="templateDetailsLink"
>
{name}
</EuiLink>
&nbsp;
</EuiLink>{' '}
<TemplateTypeIndicator templateType={item._kbnMeta.type} />
</>
</span>
);
},
},
Expand All @@ -72,8 +71,8 @@ export const TemplateTable: React.FunctionComponent<Props> = ({
name: i18n.translate('xpack.idxMgmt.templateList.table.indexPatternsColumnTitle', {
defaultMessage: 'Index patterns',
}),
truncateText: true,
sortable: true,
width: '20%',
render: (indexPatterns: string[]) => <strong>{indexPatterns.join(', ')}</strong>,
},
{
Expand All @@ -83,12 +82,15 @@ export const TemplateTable: React.FunctionComponent<Props> = ({
}),
truncateText: true,
sortable: true,
width: '20%',
render: (composedOf: string[] = []) => <span>{composedOf.join(', ')}</span>,
},
{
name: i18n.translate('xpack.idxMgmt.templateList.table.dataStreamColumnTitle', {
defaultMessage: 'Data stream',
}),
width: '90px',
align: 'center',
truncateText: true,
render: (template: TemplateListItem) =>
template._kbnMeta.hasDatastream ? <EuiIcon type="check" /> : null,
Expand Down

0 comments on commit 3562f1e

Please sign in to comment.