@todovue/tvcard v1.0.0

TvCard

The TvCard is a component that allows you to display a card with a title, a subtitle, a description, an image and a button.

Table of Contents

• Demo
• Installation
• Usage
• Props
• Events
• Customize
• Development
• Changelog
• Contributing
• License

Installation

Install with npm or yarn

npm install @todovue/tvcardd

yarn add @todovue/tvcard

Import

import { TvCard } from '@todovue/tvcard'

You can also import it directly in the main.js file, so you don't have to import it in the pages

import { createApp } from "vue";
import App from "./App.vue";
import { TvCard } from "@todovue/tvcard"

const app = createApp(App);
app.component("TvCard", TvCard);
app.mount("#app");

Usage

<template>
  <tv-card
    @click-button="handleButton"
    :configCard="configCard"
  />
</template>

<script setup>
import { ref } from "vue";
import { TvCard } from "@todovue/tvcard"

const configCard = ref({
  title: "Create Vue.js",
  description: "Vue.js (commonly known as Vue; pronounced /vjuː/...",
  alt: "Card Image",
  image: "https://todovue.com/vue.webp",
  primaryButtonText: "View more",
});

const handleButton = () => {
  console.log("Button clicked");
}
</script>

Props

configCard

Events

Customize

You can customize the card by cardConfig, you can see the props section to see the available options

const configCard = ref({
  backgroundColor: "#000000", // Card custom background color
  color: "#ffffff", // Card custom color
  backgroundButtonColor: "#ffffff", // Card custom background primary button color
  buttonColor: "#000000", // Card custom primary button color
  backgroundButtonSecondaryColor: "#ffffff", // Card custom background secondary button color
  colorButtonSecondary: "#000000", // Card custom secondary button color
});

<template>
  <tv-card
    @click-button="handleButton"
    :configCard="configCard"
  />
</template>

<script setup>
import { ref } from "vue";
import { TvCard } from "@todovue/tvcard"

const configCard = ref({
  title: "Create Vue.js",
  description: "Vue.js (commonly known as Vue; pronounced /vjuː/...",
  alt: "Card Image",
  image: "https://todovue.com/vue.webp",
  primaryButtonText: "View more",
  backgroundColor: "#000000",
  color: "#ffffff",
  backgroundButtonColor: "#ffffff",
  buttonColor: "#000000",
});

const handleButton = () => {
  console.log("Button clicked");
}
</script>

Development

Clone the repository and install the dependencies

git clone https://github.com/TODOvue/todovue-card.git

cd todovue-card

Install the dependencies

yarn install

Run the project

yarn demo

Run the tests

yarn test:unit

Run the linter

yarn lint

Run the build It is not necessary to generate build, since it is generated when you do PR to the master branch

yarn build

License

MIT