npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@canopassoftware/blog-components

v1.2.4

Published

Blog components

Downloads

12

Readme

Blog Components

Welcome to the blog-components library, a component library for canopas blogs website.

About

The blog-components is an open-source library developed and maintained by Canopas. Crafted using vue.js and tailwindcss a lightweight and highly efficient CSS platform on top of Nuxt 3 framework, showcasing a commitment to robust and advanced web development practices. For preview visit canopas blogs page .

Showcase

Blogs List UI

Blog List UI

Blogs Detail UI

Blog Detail UI

Prerequisites

Prior to integrating blog-components into your project, please ensure that tailwindcss is installed and properly configured within your project environment.

Quick Setup

  1. Add blog-components dependency to your project .

Using yarn :

yarn add --dev @canopassoftware/blog-components

Using npm :

npm install --save-dev @canopassoftware/blog-components
  1. Add blog-components to the modules section of nuxt.config.ts
export default defineNuxtConfig({
  modules: ["@canopassoftware/blog-components"],
});

That's it! You can now use module in your Nuxt app ✨

Here are the examples,

Blog list

Blog list component to show all blogs.

  <BlogList
      :posts="posts"
      :featurePosts="featurePosts"
      :count="count"
      :status="status"
    />
  • :posts="posts"

    • required
    • posts to be dispayed
  • :featurePosts="featuredPosts"

    • featured blog posts
  • :count="count"

    • Number of posts for UI adjustment
  • :status="status"

    • status of API response

Blog list by tag

Tag list component to show posts by given tag.

  <TagList
    :slug="slug"
    :posts="posts"
  />
  • :slug:"slug"
    • required
    • tag name
  • :posts="posts"
    • required
    • posts by given tag

Blog details

Component to show blog detail by slug


  <BlogDetail
      :slug="slug"
      :post="post"
      :recommandedPosts="recommandedPosts"
      :websiteUrl="your-website-url"
      :contactApiUrl="your-contact-api-url"
    />
  • :post="post"

    • required
    • slug of post
  • :post="post"

    • required
    • post detail of given slug
  • :recommandedPosts="recommandedPosts"

    • recommanded posts, which are similar to given post
  • :websiteUrl="websiteUrl"

    • For sharing on social media, you can pass your website's url
  • :contactApiUrl="contactApiUrl"

    • This api is used for CTA forms. It is not required, if you don't want to add CTAs.

Blog footer

Footer component


    <BlogFooter
      :socialMediaData="socialMediaData"
      :apiUrl="subscription-api-url"
      :companyName="your-company-name"
    />
  • :socialMediaData="socialMediaData"

    • required
    • JSON object of your social media handles
      const socialMediaData = {
          facebook: your-facebook-url,
          instagram: your-instagram-url,
          twitter: your-twitter-url,
          blog: your-blog-url,
          linkedin: your-linkedin-url,
          youtube: your-youtube-url,
      };
  • :apiUrl="subscription-api-url"

    • required
    • Subscription api url
  • :companyName="companyName"

    • your companyName

LICENSE

This repository licenced under MIT.