Network Processor Module

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

    1.0.2 • Public • Published

    JQL Editor for Connect

    Atlassian license

    This package allows Connect app developers to render a JQL Editor component to enable autocomplete-assisted authoring and validation of JQL queries. The component is pre-configured to fetch autocomplete data from Jira REST API's.

    Usage

    A minimal configuration of the JQL editor is as follows:

    import { useCallback } from 'react';
    import { JQLEditorConnect } from '@atlassianlabs/jql-editor-connect';
    
    const MyJQLEditor = () => {
      const onSearch = useCallback((jql: string) => {
        // Do some action on search    
      }, []);
      
      return (
        <JQLEditorConnect
          query={''}
          onSearch={onSearch}
          locale={"en"} 
        />
      );
    };

    Installation

    yarn add @atlassianlabs/jql-editor-connect

    Documentation

    JQLEditorConnect is a thin wrapper on top of the @atlassianlabs/jql-editor package. Refer to the JQL editor documentation to see what other configuration options are available.

    Connect scopes

    The JQL editor uses Jira Cloud REST API's to fetch autocomplete data which requires the READ scope in your app descriptor. For example:

    {
        "baseUrl": "http://my-app.com",
        "key": "atlassian-connect-app",
        "scopes": ["read"],
        "modules": {}
    }

    What's missing?

    This package does not yet support the same feature set available to the JQL editor used in Jira. The key exclusions are:

    1. User lozenges
      • The API's required to translate Atlassian account ID's to user display names is not yet available to third parties.
    2. Simplified loading of localised messages
      • Currently, to show non-english messages, consumers need to import the appropriate message set for the user's locale and render an IntlProvider in the React tree with the imported data. In the long term we'd like these localised messages to be loaded automatically based on the provided locale.

    We intend to make these features available to third party apps in future but there is currently no roadmap/timeline for inclusion.

    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-connect

    DownloadsWeekly Downloads

    34

    Version

    1.0.2

    License

    none

    Unpacked Size

    33.7 kB

    Total Files

    40

    Last publish

    Collaborators

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