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

yaml-component-library-integration

v2.1.1

Published

integrate yaml file containing data to generate components from a component library in your nextjs project

Downloads

7

Readme

yaml-component-library-integration:

is a library/package that copies components from a library to your project using a yaml file

To use this library in your Nextjs project:

1- Install the library from: https://www.npmjs.com/package/yaml-component-library-integration

npm install yaml-component-library-integration

2- Run postinstall.js script. This will adjust two things in your project:

  • The package.json will be updated with a custom script generate-components

  • The yaml-config.json and components.yaml files will be added to your root folder

      node node_modules/yaml-component-library-integration/scripts/postinstall.js

3- Adjust the paths of yaml-config.json and component names you need in components.yaml added to the root of your project.

4- To copy the components mentioned in the yaml file from the libray to the destination in your project, use:

npm run generate-components

5- To get componentsProps use:

import { getComponentProps } from 'yaml-component-library-integration';

const props = getComponentProps(component)
Component {...props}/>

Note that: you can use a custom function getComponentNames made to help import component names dynamically which might be helpful

import { getComponentsNames, getComponentProps } from 'yaml-component-library-integration';
const componentsNames = getComponentsNames('/src/app/components');
{componentsNames.length>0 && componentsNames?.map((component) => {
    const props = getComponentProps(component )
    // Dynamically import the component
    const Component = require(`./components/${component}`)?.default;
    return (
      <div key={component}>
        <h2>{component}</h2>
        <Component {...props}/>
      </div>
    );
  })}