cat-fact-component

A random cat fact web component

latest

npm

Version: 1.0.1

Version published: 6 years ago

Maintainers: 1

Created: 5 years ago

Source

cat-fact

A web component that displays a random cat fact from the Cat Facts API.

Usage

In an HTML file:

<!DOCTYPE html>
<html lang="en">
  <head>
    <!-- Use a JS module to add the component to your page -->
    <script type="module" src="index.js"></script>

    <!-- Use CSS custom properties to alter styles within the component. -->
    <style>
      :root {
        --cat-fact-bg-color: #ddd;
      }
    </style>
  </head>
  <body>
    <cat-fact></cat-fact>
  </body>
</html>

In a JavaScript application:

npm install cat-fact-component

import 'cat-fact-component';

If you are using webpack, you can instead include the component in your entry array:

module.exports = {
  entry: ['cat-fact-component', './index.js']
};

Component properties

The cat-fact component has a single configurable property:

showButton: an optional property that shows a button to allow the user to get a new fact.

<!-- Allows users to get new facts. -->
<cat-fact showButton="true"></cat-fact>

Configurable styles

Use the CSS custom properties outlined below to customize the look of the accordion from your stylesheet.

:root {
  --cat-fact-bg-color: transparent;
  --cat-fact-border: 0;
  --cat-fact-border-radius: 0;
  --cat-fact-padding: 0;

  --cat-fact-h2-margin-bottom: 1rem;

  --cat-fact-button-bg-color: inherit;
  --cat-fact-button-border: 0;
  --cat-fact-button-color: inherit;
  --cat-fact-button-font-size: 1rem;
  --cat-fact-button-margin-top: 2rem;
  --cat-fact-button-padding: inherit;
}

FAQs

What is cat-fact-component?

Is cat-fact-component well maintained?

Package last updated on 02 Mar 2020

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install