Neurosis Prevention Mechanism

    ngx-jira-issue-collector
    TypeScript icon, indicating that this package has built-in type declarations

    9.0.4 • Public • Published

    ngx-jira-issue-collector

    Commitizen friendly semantic-release

    Commands

    npm run {lint, test, build, commit, semantic-release}

    Compatibility

    Angular Channel
    8.x.x 8.x
    9.x.x 9.x

    Ivy compilation is disabled as per docs

    It is not recommended to publish Ivy libraries to NPM repositories. Before publishing a library to NPM, build it using the --prod flag which will use the older compiler and runtime known as View Engine instead of Ivy.

    Jira
    v8.2.3

    Only tested with Jira Software

    API

    import { NgxJiraIssueCollectorModule } from 'ngx-jira-issue-collector';

    @Inputs

    Input Type Required
    configuration CollectorOptions ✔️

    Example

    Jira trigger

    config: CollectorOptions = {
      baseUrl: 'https://jira.myorg.com',
      collectorId: 'coll123'
    }
    <div>
      <ngx-jira-issue-collector [configuration]="config"></ngx-jira-issue-collector>
    </div>

    Custom trigger

    config: CollectorOptions = {
      baseUrl: 'https://jira.myorg.com',
      collectorId: 'coll123'
    }
    <div>
      <button (click)="collector.showDialog()">Click me!</button>
      <ngx-jira-issue-collector [configuration]="config" #collector></ngx-jira-issue-collector>
    </div>

    Custom environment

    Environment are the properties sent to Jira if CollectorOptions.recordWebInfo is true. The default information, if the user allows collection, is:

    const environment = {
      Location: window.location.href,
      Referrer: document.referrer,
      'User-Agent': navigator.userAgent,
      'Screen Resolution': screen.width + ' x ' + screen.height
    }

    Using CollectorOptions.environment and CollectorOptions.environmentFn you can specify other defaults to collect information about the user's environment.

    config: CollectorOptions = {
      baseUrl: 'https://jira.myorg.com',
      collectorId: 'coll123',
      environment: {
        'custom-env': 'test'
      },
      environmentFn: () => {
        return {
          'custom-env2': 'test'
        }
      }
    }

    Field values

    Field values can be used to pre-populate fields in Jira, using CollectorOptions.fieldValues and CollectorOptions.fieldValuesFn.

    config: CollectorOptions = {
      baseUrl: 'https://jira.myorg.com',
      collectorId: 'coll123',
      fieldValues: {
        summary: 'Title of ticket'
      },
      fieldValuesFn: () => {
        return {
          description: 'Textarea for in-depth description'
        }
      }
    }

    The keys should correspond to a field selected in the Issue collector configuration, for custom fields refer to the jira documentation.

    Keywords

    none

    Install

    npm i ngx-jira-issue-collector

    DownloadsWeekly Downloads

    115

    Version

    9.0.4

    License

    MIT

    Unpacked Size

    214 kB

    Total Files

    40

    Last publish

    Collaborators

    • avatar