@api-components/api-server-selector

v0.7.2

Published

3 years ago

A component that renders OAS' servers as a dropdown option to select API server.

Downloads

1,926

0High
0Medium
0Low

DEPRECATED

This component is being deprecated. The code base has been moved to amf-components module. This module will be archived when PR 1 is merged.

Custom element that renders a list of servers encoded in an API specification powered by the AMF model.

Version compatibility

This version only works with AMF model version 2 (AMF parser >= 4.0.0).

Usage

Installation

npm install --save @api-components/api-server-selector

In an html file

<html>
  <head>
    <script type="module">
      import '@api-components/api-server-selector/api-server-selector.js';
    </script>
  </head>
  <body>
    <api-server-selector amf="..."></api-server-selector>
  </body>
</html>

In a LitElement

import { LitElement, html } from 'lit-element';
import '@api-components/api-server-selector/api-server-selector.js';

class SampleElement extends LitElement {
  render() {
    return html`
    <api-server-selector .amf="${this.model}"></api-server-selector>
    `;
  }
}
customElements.define('sample-element', SampleElement);

Subscribing to change events

apiserverchanged event

The component dispatches the apiserverchanged custom event when the server selection changes.

element.addEventListener('apiserverchanged', function(e) {
    const { value, type } = e.detail;
    // value is the selected base URI
    // type tells whether it's a server defined value of a custom property
    // This is also the same as const { value, type } = e.target;
});

When Custom URL is selected, a change in the input field dispatches the api-server-changed event with the current value of the input.

Additionally the element supports onapiserverchange setter for event callback function:

element.onapiserverchange = (e) => {
  // ...
};

serverscountchanged event

The event is dispatched when a number of rendered servers changed.

element.addEventListener('serverscountchanged', function(e) {
    const { value } = e.detail;
    // value is the number of rendered servers
});

element.onserverscountchange = (e) => {
  // ...
};

Custom servers

Sometimes the hosting application may want to define additional list of servers to render in the selector, other than the ones defined in the API sepcification. This can relate to additional services working with the components like a proxy or mocking service.

The element accepts list items as children that are insterted after the API defined servers. We recommend using anypoint-item as it is already used to build the selecotr. However, it can be any HTML element. For a list item to be rendered it has to have slot="custom-base-uri" attribute. For the item to be selectable in the list it has to have the value="..." attribute. If the value is missing then the item is rendered but the selector won't react on the list item click.

<api-server-selector>
  <div slot="custom-base-uri">Other options</div>
  <anypoint-item slot="custom-base-uri" data-value="http://mocking.com">Mocking service</anypoint-item>
  <anypoint-item slot="custom-base-uri"><input type="checkbox"/> Configuration option</anypoint-item>
</api-server-selector>

When you decide to use a list item without a value, a click on an item won't close the selector. When the user perform the action related to the item then use opened property on the selector to close the drop down.

<api-server-selector>
  <div slot="custom-base-uri">Other options</div>
  <anypoint-item slot="custom-base-uri"><input type="checkbox" id="option"/> Configuration option</anypoint-item>
</api-server-selector>

<script>
option.onclick = (e) => {
  e.target.parentNode.opened = false;
};
</script>

Development

git clone https://github.com/advanced-rest-client/api-server-selector
cd api-server-selector
npm install

Running the demo locally

npm start

Running the tests

npm test