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

@acctglobal/productdescription

v0.2.3

Published

<!-- ABOUT THE PROJECT -->

Downloads

8

Readme

Product Description

About The Component

This component generates description tabs agnostically, for products.

Getting Started

This component can be used anywhere you want in ecommerce, in a responsive and agnostic way.

image

  • Mobile - after applying styles

image

  • Desk - after applying styles

Installation

To use Product Description install the package via yarn or npm and import it wherever you want to use it.

  • Install package
yarn add @acctglobal/productdescription or npm install

Usage

  • Import component
import ProductDescription from '@acctglobal/productdescription';
  • Just call the component and pass with a children to customize label.
<ProductDescription loadMore="Load More" descriptionTabs={descriptionTabs} />

Styling

The CSS file that is shown in the Storybook is inside the project and was used here to show the basic functioning of the component. Initially the Component comes without any style and this css file can be used as an initial template.

There are one way to customize the component.

By data styles

[data-sf-nav-container] {
  margin: 0 auto;
  width: 100%;
  place-content: space-between;
}

| Data for styles | | :---------------------------------------------------- | | [data-sf-product-description-container] | | [data-sf-product-description-item] | | [data-sf-nav-container] | | [data-sf-nav-item] | | [data-sf-nav-link] | | [data-sf-nav-title] | | [data-sf-nav-title-active]="true" | | [data-sf-nav-title-active]="false" | | [data-sf-description-container] | | [data-sf-description-container-active]="true" | | [data-sf-description-container-active]="false" | | [data-sf-description-text] | | [data-sf-description-button] | | [data-sf-description-show-more]="false" | | [data-sf-description-show-more]="true" | | [data-sf-product-description-container-name | | [data-sf-product-description-item-desk] | | [data-sf-nav-link-desk] | | [data-sf-nav-title-desk] | | [data-sf-product-description-container-description] | | [data-sf-description-container-desk] | | [data-sf-description-button-desk] | | [data-sf-description-text-desk] |

Props

| Parameter | Type | Description | | :------------ | :------- | :----------------------------------------------------------------------------------------- | | maxHeight | number | Mandatory. max Height to condition for text to load more information | | loadMore | string | Optional. Button text to load more information | | shareLinks | Array | Mandatory. Array contain object with 2 elements [{ name: string, description: string}] | | name | string | Mandatory. Description tab title | | description | string | Mandatory. Product description |

Contributing

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request
  6. And don't forget to update the changelog

Contact

Tiago Albuquerque - [email protected]

Acknowledgments

Use this space to list resources you find helpful and would like to give credit to. I've included a few of my favorites to kick things off!