npm private modules

    @advanced-rest-client/arc-events
    TypeScript icon, indicating that this package has built-in type declarations

    0.2.21 • Public • Published

    arc-events

    A library adding events definitions to Advanced REST Client. Use this library when building a component that triggers the navigation via DOM events.

    Published on NPM

    tests

    Usage

    Installation

    npm install --save @advanced-rest-client/arc-events

    ARC request navigate event

    Dispatched to navigate to a request screen and open a request

    import { ARCNavigationEvent } from '@advanced-rest-client/arc-events';
    
    ARCNavigationEvent.navigateRequest(document.body, 'request id', 'saved');

    REST API navigate event

    Dispatched to navigate to a REST API either as the API Console or to project metadata screen.

    import { ARCNavigationEvent } from '@advanced-rest-client/arc-events';
    
    ARCNavigationEvent.navigateRestApi(document.body, 'api id', '1.0.0', 'documentation or detail');

    Project navigate event

    Dispatched to navigate to an ARC project screen.

    import { ARCNavigationEvent } from '@advanced-rest-client/arc-events';
    
    ARCNavigationEvent.navigateProject(document.body, 'project id', 'detail');

    Other navigation events

    Other events are dispatched via ARCNavigationEvent.navigate() helper function as a general purpose navigation event. It contains the base route and optional route options.

    import { ARCNavigationEvent } from '@advanced-rest-client/arc-events';
    
    ARCNavigationEvent.navigate(document.body, 'request', {
      // route params.
    });

    Development

    git clone https://github.com/advanced-rest-client/arc-events
    cd arc-events
    npm install

    Running the tests

    npm test

    Keywords

    none

    Install

    npm i @advanced-rest-client/arc-events

    DownloadsWeekly Downloads

    801

    Version

    0.2.21

    License

    Apache-2.0

    Unpacked Size

    409 kB

    Total Files

    121

    Last publish

    Collaborators

    • jarrodek
    • twoplustwoone
    • lbauret
    • carowright