@phila/phila-ui-nav-link 0.0.4 → 0.0.5-beta.0

package/README.md

@@ -1,18 +1,81 @@
-# Vue 3 + TypeScript + Vite
+# NavLink Component
 
-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.
+<!-- status-badge-start -->
 
-## Recommended IDE Setup
+![Status: Stable](https://img.shields.io/badge/-Stable-brightgreen)
 
-- [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).
+<!-- status-badge-end -->
 
-## Type Support For `.vue` Imports in TS
+A simple, customizable Vue 3. NavLink component built with TypeScript and Vite.
+navigation links
 
-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.
+## Features
 
-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:
+- 🎯 TypeScript support with full type definitions
 
-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.
+## Installation
+
+```bash
+npm install @phila/phila-ui-nav-link
+# or
+yarn add @phila/phila-ui-nav-link
+# or
+pnpm add @phila/phila-ui-nav-link
+```
+
+## Usage
+
+```vue
+<script setup lang="ts">
+import { NavLink } from "@phila/phila-ui-nav-link";
+</script>
+<template>...Add basic component template here...</template>
+```
+
+## Props
+
+| Prop | Type | Default | Description |
+| ---- | ---- | ------- | ----------- |
+
+| ...Add props here...
+
+## Events
+
+| Event | Payload | Description |
+| ----- | ------- | ----------- |
+
+| ...Add events here...
+
+## Examples
+
+...Add examples here...
+
+## Development
+
+### Install Dependencies
+
+```bash
+pnpm install
+```
+
+### Run Demo
+
+```bash
+pnpm dev
+```
+
+### Build Library
+
+```bash
+pnpm build
+```
+
+### Type Check
+
+```bash
+pnpm type-check
+```
+
+## License
+
+MIT

package/dist/NavLink.vue.d.ts

@@ -1,12 +1,4 @@
-import { NavLinkProps } from './types';
-declare const _default: import("vue").DefineComponent<__VLS_TypePropsToRuntimeProps<NavLinkProps>, {}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<import("vue").ExtractPropTypes<__VLS_TypePropsToRuntimeProps<NavLinkProps>>>, {}, {}>;
+import { NavLinkProps } from './index';
+declare const _default: import('vue').DefineComponent<NavLinkProps, {}, {}, {}, {}, import('vue').ComponentOptionsMixin, import('vue').ComponentOptionsMixin, {}, string, import('vue').PublicProps, Readonly<NavLinkProps> & Readonly<{}>, {}, {}, {}, {}, string, import('vue').ComponentProvideOptions, false, {}, HTMLDivElement>;
 export default _default;
-type __VLS_NonUndefinedable<T> = T extends undefined ? never : T;
-type __VLS_TypePropsToRuntimeProps<T> = {
-    [K in keyof T]-?: {} extends Pick<T, K> ? {
-        type: import('vue').PropType<__VLS_NonUndefinedable<T[K]>>;
-    } : {
-        type: import('vue').PropType<T[K]>;
-        required: true;
-    };
-};
+//# sourceMappingURL=NavLink.vue.d.ts.map

package/dist/NavLink.vue.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"NavLink.vue.d.ts","sourceRoot":"","sources":["../src/NavLink.vue"],"names":[],"mappings":"AA8DA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;;AAiF5C,wBASG"}

package/dist/index.css

@@ -0,0 +1 @@
+.nav-link[data-v-a1f827ab]{display:inline-flex;height:5rem;padding:0 16px;align-items:center;gap:.5rem;flex-shrink:0;color:var(--Schemes-On-Inverse-Surface-Bright, #fff);font-family:var(--Label-Default-font-label-default-family, Montserrat);font-size:var(--Label-Default-font-label-default-size, 1rem);font-style:normal;font-weight:600;line-height:var(--Label-Default-font-label-default-lineheight, 1.5rem);background:#2176d2}.nav-link[data-v-a1f827ab]:hover{background:#96c9ff}

package/dist/index.d.ts

@@ -0,0 +1,5 @@
+import { BaseProps } from '@phila/phila-ui-core';
+export { default as NavLink } from './NavLink.vue';
+export interface NavLinkProps extends BaseProps {
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAC;AACtD,OAAO,EAAE,OAAO,IAAI,OAAO,EAAE,MAAM,eAAe,CAAC;AAInD,MAAM,WAAW,YAAa,SAAQ,SAAS;CAE9C"}