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

[Search][a11y] Fixing connectors pageHeader hierarchy content #201359

Merged
merged 7 commits into from
Nov 26, 2024
Merged
Show file tree
Hide file tree
Changes from 2 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
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import React, { ChangeEvent, useEffect, useState } from 'react';

import { useActions, useValues } from 'kea';

import { EuiFlexItem, EuiInlineEditText } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { Connector } from '@kbn/search-connectors';

import { ConnectorNameAndDescriptionLogic } from './connector_name_and_description_logic';

export interface ConnectorDescriptionProps {
connector: Connector;
}

export interface ResolverObject {
rej: (value: boolean | void | PromiseLike<boolean | void>) => void;
res: (value: boolean | void | PromiseLike<boolean | void>) => void;
}

let promise: Promise<boolean | void> | undefined;

const getValidationPromiseResolvers = (): ResolverObject => {
const resolvers = {
rej: () => {},
res: () => {},
};
promise = new Promise((resolve, reject) => {
resolvers.res = resolve;
resolvers.rej = reject;
});
return resolvers;
};

export const ConnectorDescription: React.FC<ConnectorDescriptionProps> = ({ connector }) => {
const [resolverObject, setResolverObject] = useState<ResolverObject>({
rej: () => {},
res: () => {},
});
const [connectorDescription, setConnectorDescription] = useState<string | null>(
connector.description
);
const { saveNameAndDescription, setConnector } = useActions(ConnectorNameAndDescriptionLogic);
const { status, isLoading, isFailed, isSuccess } = useValues(ConnectorNameAndDescriptionLogic);

useEffect(() => {
setConnector(connector);
}, [connector]);

useEffect(() => {
if (isSuccess) {
resolverObject.res(true);
}
if (isFailed) {
resolverObject.rej();
}
}, [status]);

return (
<EuiFlexItem grow={false}>
<EuiInlineEditText
isLoading={isLoading}
inputAriaLabel={i18n.translate(
'xpack.enterpriseSearch.content.connectors.nameAndDescription.description.ariaLabel',
{ defaultMessage: 'Edit connector description' }
)}
placeholder={i18n.translate(
'xpack.enterpriseSearch.content.connectors.nameAndDescription.description.placeholder',
{ defaultMessage: 'Add a description' }
)}
value={connectorDescription || ''}
onSave={(inputValue) => {
setConnectorDescription(inputValue);
saveNameAndDescription({ description: inputValue, name: connector.name });
setResolverObject(getValidationPromiseResolvers());
return promise;
}}
onChange={(event: ChangeEvent<HTMLInputElement>) => {
setConnectorDescription(event.target.value);
}}
onCancel={(previousValue) => {
setConnectorDescription(previousValue);
}}
/>
</EuiFlexItem>
);
};
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,8 @@ import { SearchIndexPipelines } from '../search_index/pipelines/pipelines';
import { getHeaderActions } from '../shared/header_actions/header_actions';

import { ConnectorConfiguration } from './connector_configuration';
import { ConnectorNameAndDescription } from './connector_name_and_description';
import { ConnectorDescription } from './connector_description';
import { ConnectorName } from './connector_name';
import { ConnectorViewLogic } from './connector_view_logic';
import { ConnectorDetailOverview } from './overview';

Expand Down Expand Up @@ -246,7 +247,8 @@ export const ConnectorDetail: React.FC = () => {
pageViewTelemetry={tabId}
isLoading={isLoading}
pageHeader={{
pageTitle: connector ? <ConnectorNameAndDescription connector={connector} /> : '...',
description: connector ? <ConnectorDescription connector={connector} /> : '...',
pageTitle: connector ? <ConnectorName connector={connector} /> : '...',
rightSideGroupProps: {
gutterSize: 's',
responsive: false,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,108 @@
/*
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one
* or more contributor license agreements. Licensed under the Elastic License
* 2.0; you may not use this file except in compliance with the Elastic License
* 2.0.
*/

import React, { ChangeEvent, useEffect, useState } from 'react';

import { useActions, useValues } from 'kea';

import { EuiFlexItem, EuiInlineEditTitle } from '@elastic/eui';
import { i18n } from '@kbn/i18n';
import { Connector } from '@kbn/search-connectors';

import { ConnectorNameAndDescriptionLogic } from './connector_name_and_description_logic';

export interface ConnectorNameProps {
connector: Connector;
}

export interface ResolverObject {
rej: (value: boolean | void | PromiseLike<boolean | void>) => void;
res: (value: boolean | void | PromiseLike<boolean | void>) => void;
}

let promise: Promise<boolean | void> | undefined;

const getValidationPromiseResolvers = (): ResolverObject => {
const resolvers = {
rej: () => {},
res: () => {},
};
promise = new Promise((resolve, reject) => {
resolvers.res = resolve;
resolvers.rej = reject;
});
return resolvers;
};

export const ConnectorName: React.FC<ConnectorNameProps> = ({ connector }) => {
const [resolverObject, setResolverObject] = useState<ResolverObject>({
rej: () => {},
res: () => {},
});
const [connectorName, setConnectorName] = useState<string>(connector.name);
const [nameErrors, setNameErrors] = useState<string[]>([]);
const { saveNameAndDescription, setConnector } = useActions(ConnectorNameAndDescriptionLogic);
const { status, isLoading, isFailed, isSuccess } = useValues(ConnectorNameAndDescriptionLogic);

useEffect(() => {
setConnector(connector);
}, [connector]);

useEffect(() => {
if (isSuccess) {
resolverObject.res(true);
}
if (isFailed) {
resolverObject.rej();
}
}, [status]);

return (
<EuiFlexItem grow={false}>
<EuiInlineEditTitle
heading="h1"
inputAriaLabel={i18n.translate(
'xpack.enterpriseSearch.content.connectors.nameAndDescription.name.ariaLabel',
{ defaultMessage: 'Edit connector name' }
)}
placeholder={i18n.translate(
'xpack.enterpriseSearch.content.connectors.nameAndDescription.name.placeholder',
{ defaultMessage: 'Add a name to your connector' }
)}
value={connectorName}
isLoading={isLoading}
isInvalid={nameErrors.length > 0}
size="m"
editModeProps={{
cancelButtonProps: { onClick: () => setNameErrors([]) },
formRowProps: { error: nameErrors },
inputProps: { readOnly: isLoading },
}}
onSave={(inputValue) => {
if (inputValue.trim().length <= 0) {
setNameErrors([
i18n.translate('xpack.enterpriseSearch.content.nameAndDescription.name.error.empty', {
defaultMessage: 'Connector name cannot be empty',
}),
]);
return false;
}
setConnectorName(inputValue);
saveNameAndDescription({ description: connector.description, name: inputValue });
setResolverObject(getValidationPromiseResolvers());
return promise;
}}
onChange={(event: ChangeEvent<HTMLInputElement>) => {
setConnectorName(event.target.value);
}}
onCancel={(previousValue) => {
setConnectorName(previousValue);
}}
/>
</EuiFlexItem>
);
};

This file was deleted.