github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-06-27 10:40:07 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/packages/kbn-text-based-editor
History
Stratoula Kalafateli 32562aa53f
[ES|QL] Navigate to create new policy page from the editor (#167012) 
## Summary

When a user is writing am ES|QL query with the enrich command and
doesn't have a policy then we want to navigate them from the editor to
the index management page to create one.

In the future the same action can open a flyout in order for the users
to not change context but we don't have it atm.


![enrich](178362e1-6778-4b40-98a7-2fca9bc35118)

---------

Co-authored-by: Marco Liberati <dej611@users.noreply.github.com>
2023-09-27 02:58:06 -07:00
..
.storybook [Text based languages] Creates editor reusable component (#158008) 2023-05-22 14:27:38 +03:00
src [ES|QL] Navigate to create new policy page from the editor (#167012) 2023-09-27 02:58:06 -07:00
index.ts [ResponseOps][Alerting] ESQL alerting rule type ( pointed at main) (#165480) 2023-09-05 06:59:52 -07:00
jest.config.js [Text based languages] Creates editor reusable component (#158008) 2023-05-22 14:27:38 +03:00
kibana.jsonc [Text based languages] Creates editor reusable component (#158008) 2023-05-22 14:27:38 +03:00
package.json [Text based languages] Creates editor reusable component (#158008) 2023-05-22 14:27:38 +03:00
README.md [Text based languages] Creates editor reusable component (#158008) 2023-05-22 14:27:38 +03:00
tsconfig.json [ES|QL] Technical preview in Discover and Dashboards (#146971) 2023-09-01 12:22:00 +03:00

README.md

@kbn/text-based-editor

Contains the editor for text based languages. Specifically for:

  • ESQL, with autocomplete and syntax highlighting
  • SQL, with syntax highlighting

Contains the ESQL editor with the autocomplete and the autosuggest functionality (based on atlr). The antlr code can be found in packages/kbn-monaco/src/esql

A monaco based editor that is part of the unified search experience. It is rendered for all the applications that support text-based languages. In order to enable text based languages on your unified search bar add textBasedLanguages: ['SQL', 'ESQL', '...'] to the dataViewPicker properties.

Languages supported

  • SQL: based on the Elasticsearch sql api
  • ESQL: based on the Elastisearch esql api

Features

  • The editor operates in 3 modes:
    • The inline mode: This is the one liner compact mode. If the query is large or consists of >1 lines then the user can't see the entire query.
    • The inline focused mode. The editor is transferred to this mode automatically when the user clicks on the above mode. On this mode the user can work with multiple lines, see the entire context, see the errors, the editor line numbers and interact with the editor on a compact way. The editor returns automatically to the inline mode when the user clicks outside the editor.
    • The expanded mode: The user has to click the maximize button to use this mode. Here the user has more space and can also minimize/maximize the editor height with a drag and drop experience.
  • The editor has a built in way to depict the errors but the user has to submit the query first. The error should be on the inline focuses mode or the expanded mode to view the errors details.
  • The editor is responsive regardless of the mode selected.
  • The editor has a built in documentation that dynamically changes based on the language of the query.
  • The user can quickly submit the query by pressing CMD/CTRL + Enter.