@todovue/tv-ui 0.1.0 → 0.1.2

package/dist/demos/tv-demo/README.md

@@ -1,229 +0,0 @@
-<p align="center"><img width="150" src="https://res.cloudinary.com/dcdfhi8qz/image/upload/v1763663056/uqqtkgp1lg3xdplutpga.png" alt="TODOvue logo">
-</p>
-
-# TODOvue Demo Catalog (TvDemo)
-A flexible, framework-agnostic Vue 3 component catalog for demos, documentation, and playgrounds. Compatible with both SPA and SSR (Nuxt 3), with automatic style injection and no DOM assumptions.
-
-[![npm](https://img.shields.io/npm/v/@todovue/tv-demo.svg)](https://www.npmjs.com/package/@todovue/tv-demo)
-[![npm downloads](https://img.shields.io/npm/dm/@todovue/tv-demo.svg)](https://www.npmjs.com/package/@todovue/tv-demo)
-[![npm total downloads](https://img.shields.io/npm/dt/@todovue/tv-demo.svg)](https://www.npmjs.com/package/@todovue/tv-demo) 
-![License](https://img.shields.io/github/license/TODOvue/tv-demo)
-![Release Date](https://img.shields.io/github/release-date/TODOvue/tv-demo)
-![Bundle Size](https://img.shields.io/bundlephobia/minzip/@todovue/tv-demo)
-![Node Version](https://img.shields.io/node/v/@todovue/tv-demo)
-![Last Commit](https://img.shields.io/github/last-commit/TODOvue/tv-demo)
-![Stars](https://img.shields.io/github/stars/TODOvue/tv-demo?style=social)
-
-> Demo: https://ui.todovue.blog/demo/
-
----
-## Table of Contents
-- [Features](#features)
-- [Installation](#installation)
-- [Quick Start (SPA)](#quick-start-spa)
-- [Nuxt 3 / SSR Usage](#nuxt-3--ssr-usage)
-- [Component Registration Options](#component-registration-options)
-- [Props](#props)
-- [Events](#events)
-- [Customization (Styles)](#customization-styles)
-- [SSR Notes](#ssr-notes)
-- [Development](#development)
-- [Contributing](#contributing)
-- [License](#license)
-
----
-## Features
-- Visual catalog for Vue 3 components with live variants.
-- SPA and SSR (Nuxt 3) compatible.
-- Automatic import of global and highlight.js styles (no manual CSS import needed).
-- Interactive code highlighting and markdown documentation support.
-- Modular structure, easy to extend.
-- Tree-shake friendly and ready for modern bundlers.
-
----
-## Installation
-Using npm:
-```bash
-npm install @todovue/tv-demo
-```
-Using yarn:
-```bash
-yarn add @todovue/tv-demo
-```
-Using pnpm:
-```bash
-pnpm add @todovue/tv-demo
-```
-
----
-## Usage of Styles
-
-### Vue/Vite (SPA)
-Import the CSS generated by the library in your main entry file:
-```ts
-// main.ts
-import { createApp } from 'vue'
-import App from './App.vue'
-
-import '@todovue/tv-demo/style.css'
-import { TvDemo } from '@todovue/tv-demo'
-
-const app = createApp(App)
-app.component('TvDemo', TvDemo)
-app.mount('#app')
-```
-
-### Nuxt 3/4
-Add the library's CSS to your Nuxt configuration:
-```ts
-// nuxt.config.ts
-export default defineNuxtConfig({
-  css: ['@todovue/tv-demo/style.css'],
-})
-```
-
----
-## Quick Start (SPA)
-Global registration (main.js / main.ts):
-```js
-import { createApp } from 'vue'
-import App from './App.vue'
-import TvDemo from '@todovue/tv-demo'
-
-createApp(App)
-  .component('TvDemo', TvDemo)
-  .mount('#app')
-```
-Local import inside a component:
-```vue
-<script setup>
-import { TvDemo } from '@todovue/tv-demo'
-</script>
-
-<template>
-  <TvDemo />
-</template>
-```
-
----
-## Nuxt 3 / SSR Usage
-Create a plugin file: `plugins/tv-demo.client.ts` (or without suffix for SSR, it's safe):
-```ts
-import { defineNuxtPlugin } from '#app'
-import TvDemo from '@todovue/tv-demo'
-
-export default defineNuxtPlugin(nuxtApp => {
-  nuxtApp.vueApp.component('TvDemo', TvDemo)
-})
-```
-Use anywhere:
-```vue
-<TvDemo />
-```
-Direct import (no plugin):
-```vue
-<script setup>
-import { TvDemo } from '@todovue/tv-demo'
-</script>
-```
-
----
-## Component Registration Options
-| Approach                                                    | When to use                                    |
-|-------------------------------------------------------------|------------------------------------------------|
-| Global via `app.component('TvDemo', TvDemo)`                | Frequent use across the app                    |
-| Local named import `{ TvDemo }`                             | Isolated/code-split contexts                   |
-| Direct default import `import TvDemo from ...`              | Single use or manual registration              |
-
----
-## Props
-| Name              | Type    | Default       | Description                                                         | Required |
-|-------------------|---------|---------------|---------------------------------------------------------------------|----------|
-| component         | Object  |               | Component to display                                                | `true`   |
-| variants          | Array   |               | Variations of the component                                         | `true`   |
-| hideBackground    | Boolean | `false`       | Hide the background of the component demo                           | `false`  |
-| demoStyle         | Object  |               | Style of the component                                              | `false`  |
-| componentName     | String  | `null`        | Name of the component to display in the demo                        | `false`  |
-| npmInstall        | String  | `null`        | Command to install the component (without `npm install`)            | `false`  |
-| sourceLink        | String  | `null`        | Link to the source code of the component                            | `false`  |
-| urlClone          | String  | `null`        | Link to clone the repository of the component (without `git clone`) | `false`  |
-| isDevComponent    | Boolean | `false`       | Indicates that the component is in development (to include `-D`)    | `false`  |
-| version           | String  | `1.0.0`       | Version of the component                                            | `false`  |
-| readmePath        | String  | `./README.md` | Path to the README file of the component                            | `false`  |
-| showDocumentation | Boolean | `true`        | Show or hide the documentation tab                                  | `false`  |
-| showChangelog     | Boolean | `true`        | Show or hide the changelog tab                                      | `false`  |
-| manualEmits       | Array   | `[]`          | List of event names to listen relative to the component             | `false`  |
-
----
-## Events
-| Event name      | Description                                 |
-|-----------------|---------------------------------------------|
-| select-demo     | Emitted when a demo/variant is selected     |
-
-Usage:
-```vue
-<TvDemo @select-demo="onSelectDemo" />
-```
-
-Manual Emits (for async components):
-```vue
-<TvDemo
-  :component="AsyncComponent"
-  :manual-emits="['click', 'submit']"
-  :variants="demos"
-/>
-```
-
----
-## Customization (Styles)
-- All global and highlight.js styles are injected automatically.
-- You can override styles by passing the `demoStyle` prop:
-```js
-const demoStyle = ref({
-  dark: {
-    backgroundBody: "#000000",
-    backgroundContent: "#1f1f1f",
-    color: "#ffffff",
-  },
-  light: {
-    backgroundBody: "#ffffff",
-    backgroundContent: "#f5f5f5",
-    color: "#000000",
-  },
-});
-```
-Use in your component:
-```vue
-<TvDemo :component="component" :variants="demos" :demoStyle="demoStyle" />
-```
-You can provide colors for both `dark` and `light` themes, or just one. Defaults are used if not provided.
-
----
-## SSR Notes
-- No direct DOM (`window` / `document`) access in the source code—safe for SSR.
-- Styles are injected automatically when you import the library.
-- Code highlighting works in both Vite and Nuxt.
-- Markdown documentation is supported by placing your `README.md` in the `public/` folder and referencing it via the `readmePath` prop.
-
----
-## Development
-```bash
-git clone https://github.com/TODOvue/tv-demo.git
-cd tv-demo
-yarn install
-yarn dev     # run local demo
-yarn build   # build library
-```
-The local demo is served with Vite using `index.html` and examples in `src/demo`.
-
----
-## Contributing
-PRs and issues are welcome. See [CONTRIBUTING.md](../CONTRIBUTING.md) and [CODE_OF_CONDUCT.md](../CODE_OF_CONDUCT.md).
-
----
-## License
-MIT © TODOvue
-
----
-### Attributions
-Crafted for the TODOvue component ecosystem

package/dist/demos/tv-footer/CHANGELOG.md

@@ -1,67 +0,0 @@
-# Changelog
-
-All notable changes to `@todovue/tv-footer` will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [1.1.1] - 2026-01-27
-
-### Changed
-- Simplified the file list in `package.json` to include only essential assets.
-- Simplified the build configuration by removing demo-specific logic.
-- Enhanced GitHub Actions workflows to automate npm package publishing and GitHub release creation.
-- Moved the `@todovue/tv-demo` component import from main.js to `Demo.vue` to localize its usage.
-- Updated build commands to include `README.md` and `CHANGELOG.md` files in the public directory during the build process.
-
-### Added
-- Included the `src` directory in the `package.json` files list to ensure component source files are bundled in the package distribution.
-
-### Removed
-- Eliminated the global import of the `@todovue/tv-demo` component from `main.js`.
-
-### Dependencies
-- Updated `@todovue/tv-demo` to `^1.4.11`.
-- Updated `vue` to `^3.5.27`.
-- Updated `sass` to `^1.97.3`.
-
-## [1.1.0] - 2026-01-21
-
-### Added
-- Added `newsletter` properties to `useFooter` composable return.
-- Added new styles for newsletter form and back-to-top button.
-
-### Dependencies
-- Updated `@todovue/tv-demo` to `^1.4.4`.
-- Updated `sass` to `^1.97.2`.
-- Updated `vite` to `^7.3.1`.
-
-### Changed
-- Enhanced footer styles to improve visual consistency across the application.
-- Improved responsiveness of the footer component for better mobile and tablet compatibility.
-
-## [1.0.0] - 2026-01-07
-
-### Added
-- Initial release of TvFooter component
-- Responsive grid layout (1 column mobile, 2 tablet, 4 desktop)
-- Brand section with logo and name display support
-- Version display capability
-- Multiple navigation sections with titles and links
-- Social media links with icon support (iconUrl and icon class)
-- Legal links section (Privacy, Terms, etc.)
-- Dynamic copyright with automatic year replacement (`{year}` placeholder)
-- Light/Dark mode support built-in
-- SSR-safe implementation (Nuxt 3 compatible)
-- `useFooter` composable for custom implementations
-- TypeScript support with type definitions
-- Semantic HTML structure for accessibility
-- ARIA labels and proper link attributes
-- External link safety (`rel="noopener noreferrer"`)
-- Smooth hover effects and transitions
-- Backdrop blur effect on social icons
-- Comprehensive documentation and examples
-
-[1.1.1]: https://github.com/TODOvue/tv-footer/pull/3/files
-[1.1.0]: https://github.com/TODOvue/tv-footer/pull/2/files
-[1.0.0]: https://github.com/TODOvue/tv-footer/pull/1/files