Skip to content

Commit

Permalink
[Console] Apply console settings to new monaco editor (#178982)
Browse files Browse the repository at this point in the history
Closes #178966
Closes #176799

## Summary

This PR applies the console settings to the new Monaco editor:

- `fontSize`
- `wrapMode`
- `isAccessibilityOverlayEnabled`

It also modifies the `CodeEditor` component to accept an
`accessibilityOverlayEnabled` prop.

**How to test:**
1. Create a `config/kibana.dev.yml` file (if one doesn't exist already)
and add the line: `console.dev.enableMonaco: true`
2. Start Es and Kibana and navigate to Console
3. Click on Settings
4. Try changing the "Font size", "Wrap long lines", and "Accessibility
overlay" settings and verify that the changes are correctly applied to
the new monaco editor.



<!--
### 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
ElenaStoeva authored Mar 22, 2024
1 parent d96666d commit 758dafe
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 2 deletions.
8 changes: 7 additions & 1 deletion packages/shared-ux/code_editor/impl/code_editor.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -148,6 +148,11 @@ export interface CodeEditorProps {
minLines?: number;
maxLines?: number;
};

/**
* Enables the editor to get disabled when pressing ESC to resolve focus trapping for accessibility.
*/
accessibilityOverlayEnabled?: boolean;
}

export const CodeEditor: React.FC<CodeEditorProps> = ({
Expand Down Expand Up @@ -177,6 +182,7 @@ export const CodeEditor: React.FC<CodeEditorProps> = ({
defaultMessage: 'Cannot edit in read-only editor',
}),
fitToContent,
accessibilityOverlayEnabled = true,
}) => {
const { colorMode, euiTheme } = useEuiTheme();
const useDarkTheme = useDarkThemeProp ?? colorMode === 'DARK';
Expand Down Expand Up @@ -486,7 +492,7 @@ export const CodeEditor: React.FC<CodeEditorProps> = ({
data-test-subj="kibanaCodeEditor"
className="kibanaCodeEditor"
>
{renderPrompt()}
{accessibilityOverlayEnabled && renderPrompt()}

<FullScreenDisplay>
{allowFullScreen || isCopyable ? (
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,16 +10,29 @@ import React, { FunctionComponent, useState } from 'react';
import { CodeEditor } from '@kbn/code-editor';
import { css } from '@emotion/react';
import { CONSOLE_LANG_ID } from '@kbn/monaco';
import { useEditorReadContext } from '../../../contexts';

export const MonacoEditor: FunctionComponent = () => {
const { settings } = useEditorReadContext();

const [value, setValue] = useState('GET /.kibana/_search');
return (
<div
css={css`
width: 100%;
`}
>
<CodeEditor languageId={CONSOLE_LANG_ID} value={value} onChange={setValue} fullWidth={true} />
<CodeEditor
languageId={CONSOLE_LANG_ID}
value={value}
onChange={setValue}
fullWidth={true}
accessibilityOverlayEnabled={settings.isAccessibilityOverlayEnabled}
options={{
fontSize: settings.fontSize,
wordWrap: settings.wrapMode === true ? 'on' : 'off',
}}
/>
</div>
);
};

0 comments on commit 758dafe

Please sign in to comment.