@internetarchive/radial-tree v1.0.0

Wayback Radial Tree

Install

npm install

Usage

The component has few dependencies which should be loaded when it is been used a browser (UMD build):

• lodash
• d3

Usually it is enough to add them at the header of html before of the component:

<script src="https://cdn.jsdelivr.net/npm/lodash@4.17.4/lodash.min.js"></script>
<script src="https://unpkg.com/d3@4.12.0/build/d3.js"></script>

Fetch data and create site map radial tree

url='example.com'
fetch(`https://web.archive.org/web/timemap/json?
       url=${url}/&
       fl=timestamp:4,urlkey&
       atchType=prefix&
       filter=statuscode:200&
       filter=mimetype:text/html&
       collapse=timestamp:4&
       collapse=urlkey&
       limit=100000`)
  .then(res => res.json())
  .then(data => new wb.RadialTree(
    document.getElementById("rt_container"),
    data,
  ));

If you use this component in an application which uses webpack you don't to worry about dependencies they will be melted inside of build.

Developing

Testing

Right now we run eslint for style checking and mocha for unit tests.

npm test

linting only

npm run lint

unit testing

npm run mocha

Local Build

Build library and example on webpack and expose example on 8000 port.

npm run example:local

if you need custom port. For example for 4567

npm run example:local -- --port 4567

Production build

Assemble library for production use.

npm run build

In result you will get radial-tree.umd.js (browser-friendly UMD build), radial-tree.cjs.js (CommonJS (for Node)), radial-tree.esm.js (ES module (for bundlers) build) and radial-tree.css with styles.