@wastedondestiny/destiny-library 1.5.4 → 1.6.0

package/README.md

@@ -1,18 +1,64 @@
-# Vue 3 + TypeScript + Vite
+# @wastedondestiny/destiny-library
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+A Vue 3 component library and utilities for Destiny-related projects.
 
-## Recommended IDE Setup
+## Installation
 
-- [VS Code](https://code.visualstudio.com/) + [Volar](https://marketplace.visualstudio.com/items?itemName=Vue.volar) (and disable Vetur) + [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin).
+```bash
+npm install @wastedondestiny/destiny-library
+```
 
-## Type Support For `.vue` Imports in TS
+## Components
 
-TypeScript cannot handle type information for `.vue` imports by default, so we replace the `tsc` CLI with `vue-tsc` for type checking. In editors, we need [TypeScript Vue Plugin (Volar)](https://marketplace.visualstudio.com/items?itemName=Vue.vscode-typescript-vue-plugin) to make the TypeScript language service aware of `.vue` types.
+### UI Components
+- **Collapsible** - Expandable/collapsible content container
+- **DialogWindow** - Modal dialog component
+- **Dropdown** - Dropdown menu component
+- **ErrorToast** - Toast notification for error messages
+- **FallbackImage** - Image component with fallback support
+- **MarkdownContent** - Render markdown content with syntax highlighting
+- **PlatformIcon** - Display platform-specific icons
+- **Popup** - Popup/overlay component
+- **ProjectMenu** - Project navigation menu
+- **TheFooter** - Footer component
+- **TheTooltip** - Tooltip component with vue-tippy integration
 
-If the standalone TypeScript plugin doesn't feel fast enough to you, Volar has also implemented a [Take Over Mode](https://github.com/johnsoncodehk/volar/discussions/471#discussioncomment-1361669) that is more performant. You can enable it by the following steps:
+## Composables
 
-1. Disable the built-in TypeScript Extension
-   1. Run `Extensions: Show Built-in Extensions` from VSCode's command palette
-   2. Find `TypeScript and JavaScript Language Features`, right click and select `Disable (Workspace)`
-2. Reload the VSCode window by running `Developer: Reload Window` from the command palette.
+### Utilities
+- **clickOutside** - Detect clicks outside an element
+- **konami** - Konami code detection
+- **mediaQuery** - Responsive media query helper
+- **google** - Google integration utilities
+- **playwire** - Playwire ad integration
+
+## Usage
+
+```javascript
+import { Collapsible, DialogWindow, ErrorToast } from '@wastedondestiny/destiny-library'
+import { useClickOutside, useKonami, useMediaQuery } from '@wastedondestiny/destiny-library'
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Start dev server
+npm run dev
+
+# Build library
+npm run build
+
+# Run tests
+npm test
+```
+
+## Peer Dependencies
+
+- Vue ^3.2.47
+
+## License
+
+MIT

package/dist/components/Dialog.vue.d.ts

@@ -0,0 +1,10 @@
+import { type Dialog } from '../types';
+type __VLS_Props = {
+    dialog: Dialog;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    close: (...args: any[]) => void;
+}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{
+    onClose?: ((...args: any[]) => any) | undefined;
+}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/FallbackImage.vue.d.ts

@@ -0,0 +1,9 @@
+type __VLS_Props = {
+    src: string;
+    fallbackSrc: string;
+    alt?: string;
+};
+declare const _default: import("vue").DefineComponent<__VLS_Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<__VLS_Props> & Readonly<{}>, {
+    alt: string;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;

package/dist/components/MarkdownContent.vue.d.ts

@@ -0,0 +1,5 @@
+interface Props {
+    url: string;
+}
+declare const _default: import("vue").DefineComponent<Props, void, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<Props> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>;
+export default _default;