@internetarchive/ia-item-navigator
v2.1.2
Published
Internet Archive's Item Navigator, visually explore an item's contents.
Downloads
547
Maintainers
Keywords
Readme
Internet Archive Item Navigator - theater menu manager
<ia-item-navigator>
is a custom web component that makes an item's details theater.
The Item Navigator helps instantiate all of the components one needs to create an item theater:
- side menu
- menu shortcuts
- fullscreen management
- receives/creates a shared resize observer
- receives/shares a
<modal-manager>
- slots for custom theater & header loads
The Item Navigator's primary responsibility is to display the side menus, shortcuts, and the theater in browser window immersion "fullscreen".
The main slot is shown by default. If item has no theater, add viewAvailable = false
property to show placeholder.
Usage
Generic:
const iaItem = <MetadataResponse>;
<ia-item-navigator .item=${iaItem}></ia-item-navigator>
Local Demo with web-dev-server
yarn start
To run a local development server that serves the basic demo located in demo/index.html
Testing with Web Test Runner
To run the suite of Web Test Runner tests, run
yarn run test
To run the tests in watch mode (for <abbr title="test driven development">TDD</abbr>, for example), run
yarn run test:watch
Linting with ESLint, Prettier, and Types
To scan the project for linting errors, run
yarn run lint
You can lint with ESLint and Prettier individually as well
yarn run lint:eslint
yarn run lint:prettier
To automatically fix many linting errors, run
yarn run format
You can format using ESLint and Prettier individually as well
yarn run format:eslint
yarn run format:prettier