@cosmicds/vue-toolkit 0.2.0 → 0.4.0

package/dist/src/background.d.ts

@@ -1,6 +1,10 @@
+/** Class representing a background imageset for WorldWide Telescope */
 export declare class BackgroundImageset {
+    /** The outward-facing name to use for the imageset in a story */
     imagesetName: string;
+    /** The name of the imageset object inside WorldWide Telescope */
     displayName: string;
     constructor(displayName: string, imagesetName: string);
 }
+/** A default list of `BackgroundImagset` objects to use within data stories */
 export declare const skyBackgroundImagesets: BackgroundImageset[];

package/dist/src/components/CreditLogos.vue.d.ts

@@ -1,3 +1,28 @@
-export declare function render(_ctx: any, _cache: any, $props: any, $setup: any, $data: any, $options: any): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+declare const _default: import("vue").DefineComponent<{
+    logoSize: {
+        default: string;
+    };
+    extraLogos: {
+        default: () => never[];
+    };
+    defaultLogos: {
+        default: () => string[];
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    logoSize: {
+        default: string;
+    };
+    extraLogos: {
+        default: () => never[];
+    };
+    defaultLogos: {
+        default: () => string[];
+    };
+}>>, {
+    logoSize: string;
+    extraLogos: never[];
+    defaultLogos: string[];
+}, {}>;
+export default _default;

package/dist/src/components/FundingAcknowledgement.vue.d.ts

@@ -0,0 +1,21 @@
+declare const _default: import("vue").DefineComponent<{
+    color: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    color: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+}>>, {
+    color: string;
+    backgroundColor: string;
+}, {}>;
+export default _default;

package/dist/src/components/Gallery.vue.d.ts

@@ -1,3 +1,80 @@
-export declare function render(_ctx: any, _cache: any, $props: any, $setup: any, $data: any, $options: any): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+declare const _default: import("vue").DefineComponent<{
+    wtmlUrl: {};
+    columns: {
+        default: string;
+    };
+    width: {
+        default: string;
+    };
+    maxHeight: {
+        default: string;
+    };
+    title: {
+        default: string;
+    };
+    selectedColor: {
+        default: string;
+    };
+    singleSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    highlightLastOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    previewIndex: {
+        default: number;
+    };
+    closedText: {
+        default: string;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("select" | "deselect" | "listAllSelected")[], "select" | "deselect" | "listAllSelected", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    wtmlUrl: {};
+    columns: {
+        default: string;
+    };
+    width: {
+        default: string;
+    };
+    maxHeight: {
+        default: string;
+    };
+    title: {
+        default: string;
+    };
+    selectedColor: {
+        default: string;
+    };
+    singleSelect: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    highlightLastOnly: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    previewIndex: {
+        default: number;
+    };
+    closedText: {
+        default: string;
+    };
+}>> & {
+    onSelect?: ((...args: any[]) => any) | undefined;
+    onDeselect?: ((...args: any[]) => any) | undefined;
+    onListAllSelected?: ((...args: any[]) => any) | undefined;
+}, {
+    columns: string;
+    width: string;
+    maxHeight: string;
+    title: string;
+    selectedColor: string;
+    singleSelect: boolean;
+    highlightLastOnly: boolean;
+    previewIndex: number;
+    closedText: string;
+}, {}>;
+export default _default;

package/dist/src/components/GeolocationButton.vue.d.ts

@@ -0,0 +1,132 @@
+declare const _default: import("vue").DefineComponent<{
+    color: {
+        default: string;
+    };
+    size: {
+        default: string;
+    };
+    density: {
+        default: string;
+    };
+    elevation: {
+        default: string;
+    };
+    hideButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showTextLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showCoords: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showTextProgress: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showProgressCircle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    useTextButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    progressCircleSize: {
+        default: number;
+    };
+    label: {
+        default: string;
+    };
+    id: {};
+    trueIcon: {
+        default: string;
+    };
+    falseIcon: {
+        default: string;
+    };
+    showPermissions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("error" | "geolocation" | "permission")[], "error" | "geolocation" | "permission", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    color: {
+        default: string;
+    };
+    size: {
+        default: string;
+    };
+    density: {
+        default: string;
+    };
+    elevation: {
+        default: string;
+    };
+    hideButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showTextLabel: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showCoords: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showTextProgress: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    showProgressCircle: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    useTextButton: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    progressCircleSize: {
+        default: number;
+    };
+    label: {
+        default: string;
+    };
+    id: {};
+    trueIcon: {
+        default: string;
+    };
+    falseIcon: {
+        default: string;
+    };
+    showPermissions: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+}>> & {
+    onError?: ((...args: any[]) => any) | undefined;
+    onGeolocation?: ((...args: any[]) => any) | undefined;
+    onPermission?: ((...args: any[]) => any) | undefined;
+}, {
+    size: string;
+    color: string;
+    label: string;
+    density: string;
+    elevation: string;
+    hideButton: boolean;
+    showTextLabel: boolean;
+    showCoords: boolean;
+    showTextProgress: boolean;
+    showProgressCircle: boolean;
+    useTextButton: boolean;
+    progressCircleSize: number;
+    trueIcon: string;
+    falseIcon: string;
+    showPermissions: boolean;
+}, {}>;
+export default _default;

package/dist/src/components/IconButton.vue.d.ts

@@ -1,3 +1,131 @@
-export declare function render(_ctx: any, _cache: any, $props: any, $setup: any, $data: any, $options: any): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+declare const _default: import("vue").DefineComponent<{
+    modelValue: {
+        type: BooleanConstructor;
+    };
+    faIcon: {};
+    mdIcon: {};
+    color: {
+        default: string;
+    };
+    focusColor: {
+        default: string;
+    };
+    activeColor: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    longPressTimeMs: {
+        default: number;
+    };
+    tooltipText: {};
+    tooltipLocation: {
+        default: string;
+    };
+    tooltipOnClick: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOnFocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOnHover: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOffset: {
+        default: number;
+    };
+    showTooltip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    faSize: {
+        default: string;
+    };
+    mdSize: {
+        default: string;
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("update:modelValue" | "activate")[], "update:modelValue" | "activate", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    modelValue: {
+        type: BooleanConstructor;
+    };
+    faIcon: {};
+    mdIcon: {};
+    color: {
+        default: string;
+    };
+    focusColor: {
+        default: string;
+    };
+    activeColor: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+    border: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    longPressTimeMs: {
+        default: number;
+    };
+    tooltipText: {};
+    tooltipLocation: {
+        default: string;
+    };
+    tooltipOnClick: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOnFocus: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOnHover: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    tooltipOffset: {
+        default: number;
+    };
+    showTooltip: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    faSize: {
+        default: string;
+    };
+    mdSize: {
+        default: string;
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onActivate?: ((...args: any[]) => any) | undefined;
+}, {
+    border: boolean;
+    color: string;
+    backgroundColor: string;
+    modelValue: boolean;
+    focusColor: string;
+    longPressTimeMs: number;
+    tooltipLocation: string;
+    tooltipOnClick: boolean;
+    tooltipOnFocus: boolean;
+    tooltipOnHover: boolean;
+    showTooltip: boolean;
+    faSize: string;
+    mdSize: string;
+    activeColor: string;
+    tooltipOffset: number;
+}, {}>;
+export default _default;

package/dist/src/components/LocationSelector.vue.d.ts

@@ -1,3 +1,140 @@
-export declare function render(_ctx: any, _cache: any, $props: any, $setup: any, $data: any, $options: any): import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+import L from 'leaflet';
+import "leaflet/dist/leaflet.css";
+import { LeafletMapOptions } from "../types";
+declare const _default: import("vue").DefineComponent<{
+    activatorColor: {
+        default: string;
+    };
+    detectLocation: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        default: () => {
+            latitudeDeg: number;
+            longitudeDeg: number;
+        };
+    };
+    mapOptions: {
+        default: () => LeafletMapOptions;
+    };
+    initialPlace: {};
+    places: {
+        default: () => never[];
+    };
+    placeCircleOptions: {
+        default: () => L.CircleMarkerOptions;
+    };
+    placeSelectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectedCircleOptions: {
+        default: () => {
+            color: string;
+            fillColor: string;
+            fillOpacity: number;
+            radius: number;
+        };
+    };
+    selectionEvent: {
+        default: string;
+    };
+    worldRadii: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    geoJsonFiles: {
+        default: () => never[];
+    };
+    layers: {
+        default: () => never[];
+    };
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
     [key: string]: any;
-}>;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, ("place" | "error" | "update:modelValue" | "mapReady")[], "place" | "error" | "update:modelValue" | "mapReady", import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    activatorColor: {
+        default: string;
+    };
+    detectLocation: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    modelValue: {
+        default: () => {
+            latitudeDeg: number;
+            longitudeDeg: number;
+        };
+    };
+    mapOptions: {
+        default: () => LeafletMapOptions;
+    };
+    initialPlace: {};
+    places: {
+        default: () => never[];
+    };
+    placeCircleOptions: {
+        default: () => L.CircleMarkerOptions;
+    };
+    placeSelectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectable: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    selectedCircleOptions: {
+        default: () => {
+            color: string;
+            fillColor: string;
+            fillOpacity: number;
+            radius: number;
+        };
+    };
+    selectionEvent: {
+        default: string;
+    };
+    worldRadii: {
+        type: BooleanConstructor;
+        default: boolean;
+    };
+    geoJsonFiles: {
+        default: () => never[];
+    };
+    layers: {
+        default: () => never[];
+    };
+}>> & {
+    "onUpdate:modelValue"?: ((...args: any[]) => any) | undefined;
+    onPlace?: ((...args: any[]) => any) | undefined;
+    onError?: ((...args: any[]) => any) | undefined;
+    onMapReady?: ((...args: any[]) => any) | undefined;
+}, {
+    modelValue: {
+        latitudeDeg: number;
+        longitudeDeg: number;
+    };
+    activatorColor: string;
+    detectLocation: boolean;
+    placeSelectable: boolean;
+    selectable: boolean;
+    selectionEvent: string;
+    worldRadii: boolean;
+    mapOptions: LeafletMapOptions;
+    places: never[];
+    placeCircleOptions: L.CircleMarkerOptions;
+    selectedCircleOptions: {
+        color: string;
+        fillColor: string;
+        fillOpacity: number;
+        radius: number;
+    };
+    geoJsonFiles: never[];
+    layers: never[];
+}, {}>;
+export default _default;

package/dist/src/components/WwtHud.vue.d.ts

@@ -0,0 +1,69 @@
+declare const _default: import("vue").DefineComponent<{
+    location: {
+        default: () => {
+            top: string;
+            left: string;
+        };
+    };
+    offsetCenter: {
+        default: () => {
+            x: number;
+            y: number;
+        };
+    };
+    otherVariables: {
+        default: () => {};
+    };
+    fontSize: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+    textShadow: {
+        default: string;
+    };
+    store: {};
+}, (_ctx: any, _cache: any) => import("vue").VNode<import("vue").RendererNode, import("vue").RendererElement, {
+    [key: string]: any;
+}>, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<{
+    location: {
+        default: () => {
+            top: string;
+            left: string;
+        };
+    };
+    offsetCenter: {
+        default: () => {
+            x: number;
+            y: number;
+        };
+    };
+    otherVariables: {
+        default: () => {};
+    };
+    fontSize: {
+        default: string;
+    };
+    backgroundColor: {
+        default: string;
+    };
+    textShadow: {
+        default: string;
+    };
+    store: {};
+}>>, {
+    location: {
+        top: string;
+        left: string;
+    };
+    backgroundColor: string;
+    fontSize: string;
+    textShadow: string;
+    offsetCenter: {
+        x: number;
+        y: number;
+    };
+    otherVariables: {};
+}, {}>;
+export default _default;

package/dist/src/composables.d.ts

@@ -0,0 +1,25 @@
+import { Ref } from "vue";
+/**
+  * A composable that encapsulates fullscreen behavior.
+  * @returns A reactive variable indicating whether or not fullscreen mode is active
+  */
+export declare function useFullscreen(): Ref<boolean>;
+/** Interface describing the shape of a browser window */
+export interface WindowShape {
+    width: number;
+    height: number;
+}
+/** A default `WindowShape` to use */
+export declare const defaultWindowShape: {
+    width: number;
+    height: number;
+};
+/**
+  * A composable that encapsulates a changing window shape.
+  *
+  * @returns A reactive variable describing the current window shape.
+  */
+export declare function useWindowShape(): Ref<{
+    width: number;
+    height: number;
+}>;

package/dist/src/geolocation.d.ts

@@ -0,0 +1,31 @@
+import { Position } from "@capacitor/geolocation";
+export type PositionCoords = Position['coords'];
+/**
+  * A composable that encapsulates the current state of the browser
+  * geolocation position and permission status.
+  * @param onStartup - Whether or not to query the user's geolocation on startup.
+  * @returns Reactive state describing the geolocation
+  */
+export declare function useGeolocation(onStartup?: boolean): {
+    geolocation: import("vue").Ref<{
+        latitude: number;
+        longitude: number;
+        accuracy: number;
+        altitudeAccuracy: number | null | undefined;
+        altitude: number | null;
+        speed: number | null;
+        heading: number | null;
+    } | null>;
+    error: import("vue").Ref<{
+        readonly code: number;
+        readonly message: string;
+        readonly PERMISSION_DENIED: number;
+        readonly POSITION_UNAVAILABLE: number;
+        readonly TIMEOUT: number;
+    } | null>;
+    permissions: import("vue").Ref<string>;
+    permissionGranted: import("vue").Ref<boolean>;
+    hasPermissionsAPI: import("vue").Ref<boolean>;
+    handlePosition: (position: Position) => void;
+    geolocate: () => Promise<Position>;
+};