@internetarchive/elements 0.2.14-webdev-8969.0 → 0.3.0

package/README.md

@@ -143,6 +143,26 @@ src
 ```
 Export your component in `src/index.ts`
 
+### Naming
+Custom elements all share one global registry, and that registry is shared with every other script on the host page. Give each element a name specific enough that nothing else would plausibly want it.
+
+If a component is built from several elements, prefix its parts with the component's own name rather than naming them generically, and keep the file name matching the tag:
+```
+src
+- elements
+  - ia-foobar
+    - ia-foobar.ts // ia-foobar
+    - ia-foobar-list-item.ts // ia-foobar-list-item, not ia-list-item
+```
+Declare each element in `HTMLElementTagNameMap` so `querySelector` is typed and a mistyped tag in a template is caught at build time:
+```ts
+declare global {
+  interface HTMLElementTagNameMap {
+    'ia-foobar-list-item': IAFoobarListItem;
+  }
+}
+```
+
 ### Story
 To demo your component, we have a component catalog that you can add your demo to. Create a component in your component directory. Name it `COMPONENT-NAME-story.ts`, ie `ia-button-story.ts`.
 

package/dist/src/elements/ia-item-navigator/ia-item-navigator.d.ts

@@ -0,0 +1,97 @@
+import { LitElement, TemplateResult, nothing, type CSSResultGroup } from 'lit';
+import './ia-itemnav-menu-slider.js';
+import './ia-itemnav-no-theater-available.js';
+import { ToggleSideMenuOpenEvent, ToggleSidePanelOpenEvent, SetSideMenuContentsEvent, SetSideMenuShortcutsEvent, LoadingStateUpdatedEvent, ManageFullscreenEvent } from './interfaces/event-interfaces.js';
+import { MenuProviderInterface, MenuShortcutInterface, MenuId } from './interfaces/menu-interfaces.js';
+/**
+ * A fullscreen-capable frame that hosts an Archive.org item's theater. The
+ * consumer projects a header bar and the theater itself into the `header` and
+ * `main` slots; a collapsible left drawer (`ia-itemnav-menu-slider`) is driven by a
+ * data array of menu providers, and a minimized rail shows shortcut icons.
+ *
+ * The navigator is a shell — it does not know how to render any particular
+ * viewer. Menu panel bodies are opaque `TemplateResult`s supplied by the
+ * consumer via `menuContents`.
+ */
+export declare class IAItemNavigator extends LitElement {
+    /** archive.org item identifier. */
+    identifier?: string;
+    viewAvailable: boolean;
+    baseHost: string;
+    signedIn: boolean;
+    menuContents: MenuProviderInterface[];
+    menuShortcuts: MenuShortcutInterface[];
+    viewportInFullscreen: boolean | null;
+    menuOpened: boolean;
+    openMenu?: MenuId;
+    /**
+     * Whether the slotted theater is ready. While false the reader stays
+     * hidden and the frame is empty.
+     *
+     * The navigator used to fill that gap with its own spinner, but a shell
+     * shouldn't decide what loading looks like — and its glyph and fullscreen
+     * caption were branding a consumer couldn't override. An indicator returns
+     * once WEBDEV-8951 moves the shared status indicators into elements, so the
+     * navigator can use that one instead of carrying its own.
+     */
+    loaded: boolean;
+    /**
+     * Set for the render where the drawer opens straight to a panel, so the
+     * panel holds still and rides in. Every other path clears it, rather
+     * than waiting for the drawer's `transitionend` — that never fires when
+     * animations are disabled, which would strand the flag on.
+     */
+    private drawerEntering;
+    private menuSlider;
+    private toggleMenuButton;
+    slotChange(e: Event, type: 'header' | 'main'): void;
+    render(): TemplateResult;
+    get noTheaterView(): TemplateResult;
+    get renderViewport(): TemplateResult | typeof nothing;
+    loadingStateUpdated(e: LoadingStateUpdatedEvent): void;
+    /** Fullscreen Management */
+    manageViewportFullscreen(e: ManageFullscreenEvent): void;
+    /** End Fullscreen Management */
+    /** Side menu */
+    get shouldRenderMenu(): boolean;
+    toggleMenu(forceValue?: boolean | undefined): void;
+    /**
+     * Opening the drawer moves focus into it; closing hands focus back to the
+     * toggle. Without this, opening from the shortcut rail would leave focus on
+     * a button that is about to be hidden, dropping it to the document.
+     */
+    private moveFocusForDrawer;
+    /**
+     * Closing the drawer also closes whatever panel was open inside it, so the
+     * two can't disagree and a stale panel can't reappear on the next open.
+     */
+    closeMenu(): void;
+    setOpenMenu(e: ToggleSidePanelOpenEvent): void;
+    /**
+     * Clears the open channel when the slider closes its sub-panel, without
+     * closing the drawer. Keeps `openMenu` in sync with the slider so the same
+     * channel can be reopened afterwards.
+     */
+    closeSidePanel(): void;
+    setMenuContents(e: SetSideMenuContentsEvent): void;
+    setMenuShortcuts(e: SetSideMenuShortcutsEvent): void;
+    /** Toggles Side Menu & Sets viewable subpanel  */
+    manageSideMenuEvents(e: ToggleSideMenuOpenEvent): void;
+    get menuToggleButton(): TemplateResult;
+    get selectedMenuId(): MenuId | '';
+    get renderSideMenu(): TemplateResult;
+    /** End Side menu */
+    /** Menu Shortcuts */
+    openShortcut(selectedMenuId?: MenuId): void;
+    get shortcuts(): TemplateResult;
+    /** End Menu Shortcuts */
+    /** Misc Render */
+    get menuClass(): string;
+    static get styles(): CSSResultGroup;
+}
+declare global {
+    interface HTMLElementTagNameMap {
+        'ia-item-navigator': IAItemNavigator;
+    }
+}
+//# sourceMappingURL=ia-item-navigator.d.ts.map

package/dist/src/elements/ia-item-navigator/ia-item-navigator.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ia-item-navigator.d.ts","sourceRoot":"","sources":["../../../../src/elements/ia-item-navigator/ia-item-navigator.ts"],"names":[],"mappings":"AAAA,OAAO,EAGL,UAAU,EACV,cAAc,EACd,OAAO,EACP,KAAK,cAAc,EACpB,MAAM,KAAK,CAAC;AAMb,OAAO,0BAA0B,CAAC;AAClC,OAAO,mCAAmC,CAAC;AAG3C,OAAO,EACL,uBAAuB,EACvB,wBAAwB,EACxB,wBAAwB,EACxB,yBAAyB,EACzB,wBAAwB,EACxB,qBAAqB,EACtB,MAAM,+BAA+B,CAAC;AACvC,OAAO,EACL,qBAAqB,EACrB,qBAAqB,EACrB,MAAM,EACP,MAAM,8BAA8B,CAAC;AAEtC;;;;;;;;;GASG;AACH,qBACa,eAAgB,SAAQ,UAAU;IAC7C,mCAAmC;IACP,UAAU,CAAC,EAAE,MAAM,CAAC;IAEJ,aAAa,EAAE,OAAO,CAAQ;IAE9C,QAAQ,SAAiB;IAExB,QAAQ,UAAS;IAEnB,YAAY,EAAE,qBAAqB,EAAE,CAAM;IAE3C,aAAa,EAAE,qBAAqB,EAAE,CAAM;IAGvE,oBAAoB,EAAE,OAAO,GAAG,IAAI,CAAQ;IAEA,UAAU,UAAS;IAEpB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAE7D;;;;;;;;;OASG;IAC0D,MAAM,EAAE,OAAO,CACpE;IAER;;;;;OAKG;IACM,OAAO,CAAC,cAAc,CAAS;IAEP,OAAO,CAAC,UAAU,CAAuB;IAE7C,OAAO,CAAC,gBAAgB,CAAqB;IAE1E,UAAU,CAAC,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,QAAQ,GAAG,MAAM,GAAG,IAAI;IAanD,MAAM,IAAI,cAAc;IAkBxB,IAAI,aAAa,IAAI,cAAc,CAKlC;IAED,IAAI,cAAc,IAAI,cAAc,GAAG,OAAO,OAAO,CAcpD;IAED,mBAAmB,CAAC,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAKtD,4BAA4B;IAC5B,wBAAwB,CAAC,CAAC,EAAE,qBAAqB,GAAG,IAAI;IAUxD,gCAAgC;IAEhC,gBAAgB;IAChB,IAAI,gBAAgB,IAAI,OAAO,CAE9B;IAED,UAAU,CAAC,UAAU,GAAE,OAAO,GAAG,SAAqB,GAAG,IAAI;IAM7D;;;;OAIG;IACH,OAAO,CAAC,kBAAkB;IAU1B;;;OAGG;IACH,SAAS,IAAI,IAAI;IAKjB,WAAW,CAAC,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAM9C;;;;OAIG;IACH,cAAc,IAAI,IAAI;IAKtB,eAAe,CAAC,CAAC,EAAE,wBAAwB,GAAG,IAAI;IAKlD,gBAAgB,CAAC,CAAC,EAAE,yBAAyB,GAAG,IAAI;IAIpD,kDAAkD;IAClD,oBAAoB,CAAC,CAAC,EAAE,uBAAuB,GAAG,IAAI;IActD,IAAI,gBAAgB,IAAI,cAAc,CAcrC;IAED,IAAI,cAAc,IAAI,MAAM,GAAG,EAAE,CAEhC;IAED,IAAI,cAAc,IAAI,cAAc,CA2BnC;IACD,oBAAoB;IAEpB,qBAAqB;IACrB,YAAY,CAAC,cAAc,GAAE,MAAW,GAAG,IAAI;IAa/C,IAAI,SAAS,IAAI,cAAc,CAuB9B;IACD,yBAAyB;IAEzB,kBAAkB;IAClB,IAAI,SAAS,IAAI,MAAM,CAUtB;IAED,MAAM,KAAK,MAAM,IAAI,cAAc,CAoRlC;CACF;AAED,OAAO,CAAC,MAAM,CAAC;IACb,UAAU,qBAAqB;QAC7B,mBAAmB,EAAE,eAAe,CAAC;KACtC;CACF"}