This package has been deprecated

Author message:

Use @advanced-rest-client/arc-menu instead.

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

3.0.0 • Public • Published

Published on NPM

Build Status

Published on webcomponents.org

<saved-menu>

The saved menu for Advanced REST Client is accessible list of saved items retrieved from local data store.

Usage

Installation

npm install --save @advanced-rest-client/saved-menu

In a LitElement

import { LitElement, html } from 'lit-element';
import '@advanced-rest-client/saved-menu/saved-menu.js';

class SampleElement extends LitElement {
  get styles() {
    return css`
      saved-menu {
        height: 500px;
      }
    `;
  }

  render() {
    return html`
    <saved-menu draggableenabled></saved-menu>
    `;
  }
}
customElements.define('sample-element', SampleElement);

List sizing

It is important to set implicit height of the element. It can be static value like 500px, relative value like 100% as long as a parent is sized for height, or a flex value, as long as parent is sized for height. The list of requests is set to load only portion of the requests from the data store and load more when list scroll is near end. If there's no scroll then the element will load whole data store at initialization time.

Drag and drop

API components related to a request object support drag and drop. Set draggableenabled property to enable the support.

The DataTransfer property of the drag event contains effectAllowed set to copy as this is only allowed operation on a saved object. Only targets that allow the same effect will accept the saved item. The same propery contains serialized request data under arc/request-object media type. It contains request ID under arc/saved-request and arc-source/saved-menu media types.

_dropHandler(e) {
  e.preventDefault();
  const data = e.dataTransfer.getData('arc/request-object');
  const request = JSON.parse(data);
  const id = e.dataTransfer.getData('arc/saved-request');
  console.log(request, id);
}

Development

git clone https://github.com/advanced-rest-client/saved-list-mixin
cd saved-list-mixin
npm install

Running the tests

npm test

API components

This components is a part of API components ecosystem

Package Sidebar

Install

npm i @advanced-rest-client/saved-menu

Weekly Downloads

1

Version

3.0.0

License

Apache-2.0

Unpacked Size

62.4 kB

Total Files

6

Last publish

Collaborators

  • carowright
  • jarrodek
  • twoplustwoone
  • lbauret