@atlassianlabs/jql-editor
    TypeScript icon, indicating that this package has built-in type declarations

    1.1.0 • Public • Published

    JQL Editor

    Atlassian license

    This package allows consumers to render an advanced JQL editor component to enable autocomplete-assisted authoring and validation of JQL queries.

    Usage

    To render the editor, the consumer must configure an autocompleteProvider, which defines callback functions used to retrieve JQL fields, functions and values. To ease configuration, we also ship the @atlassianlabs/jql-editor-autocomplete-rest package, which wraps these callbacks and provides simple hooks to delegate to Jira REST API's.

    A minimal configuration of the JQL editor is as follows:

    import { useCallback } from 'react';
    import { JQLEditorAsync as JQLEditor } from '@atlassianlabs/jql-editor';
    import { useAutocompleteProvider } from '@atlassianlabs/jql-editor-autocomplete-rest';
    
    const getInitialData = async (url: string) => {
      const response = await fetch(url, {
        method: 'POST',
        headers: { 'Content-Type': 'application/json' },
        body: JSON.stringify({ includeCollapsedFields: true })
      });
      const data = response.json();
    
      return {
        jqlFields: data.visibleFieldNames,
        jqlFunctions: data.visibleFunctionNames,
      };
    };
    
    const getSuggestions = async (url: string) => {
      const response = await fetch(url);
      return response.json();
    };
    
    const MyJQLEditor = () => {
      const autocompleteProvider = useAutocompleteProvider('my-app', getInitialData, getSuggestions);
    
      const onSearch = useCallback((jql: string) => {
        // Do some action on search    
      }, []);
    
      return (
        <JQLEditor
          analyticsSource={'my-app'}
          query={''}
          onSearch={onSearch}
          autocompleteProvider={autocompleteProvider}
          locale={"en"}
        />
      );
    };

    For app developers, please refer to the @atlassianlabs/jql-editor-connect and @atlassianlabs/jql-editor-forge packages. Which come pre-configured with Jira autocomplete integration.

    Installation

    yarn add @atlassianlabs/jql-editor

    Documentation

    Searching and authoring JQL

    There are two main use cases for the editor:

    1. Searching by a JQL query
    2. Authoring a JQL query

    The key difference between the two is that rendering a search button may not make sense when authoring JQL, e.g. when using the JQL editor as a form input. The searching use case is documented above, here we'll discuss authoring.

    Authoring JQL

    Hiding the search button is as simple as not providing an onSearch prop. Instead you'll want to use onUpdate which is triggered whenever the query is updated.

    By default, the editor will automatically show any syntax errors when the user presses search. Without the search button the consumer will need to set errors to show manually.

    import { useCallback, useMemo, useState } from 'react';
    import { Jast, JQLParseError } from '@atlassianlabs/jql-ast';
    import { JQLEditorAsync as JQLEditor, CustomJqlError } from '@atlassianlabs/jql-editor';
    import debounce from 'lodash/debounce';
    
    const MyJQLEditor = () => {
      const [errors, setErrors] = useState<CustomJqlError[]>([]);
    
      const debounceSetErrors = useMemo(() => {
        // Update our errors after a 1 second debounce
        return debounce((parseErrors: JQLParseError[]) => {
          // Format JQL parse errors to be shown as custom error messages in the editor
          const errorMessages: CustomJqlError[] = parseErrors.map(({ description }) => ({ message: description }));
          setErrors(errorMessages)
        }, 1000);
      }, [setErrors]);
    
      const onUpdate = useCallback((jql: string, jast: Jast) => {
        debounceSetErrors(jast.errors)
      }, []);
    
      return (
        <JQLEditor
          analyticsSource={'my-app'}
          query={''}
          onUpdate={onUpdate}
          errors={errors}
          autocompleteProvider={/* ... */}
          locale={"en"}
        />
      );
    };

    Support

    For developers outside of Atlassian looking for help, or to report issues, please make a post on the community forum . We will monitor the forums and redirect topics to the appropriate maintainers.

    License

    Copyright (c) 2021 - 2022 Atlassian and others. Apache 2.0 licensed, see LICENSE file.

    Keywords

    none

    Install

    npm i @atlassianlabs/jql-editor

    DownloadsWeekly Downloads

    370

    Version

    1.1.0

    License

    Apache-2.0

    Unpacked Size

    1.2 MB

    Total Files

    542

    Last publish

    Collaborators

    • doklovic
    • prkb
    • crumley
    • nrundquist
    • dkolbly-atlassian
    • kpainter-atl
    • soneymathew