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

dcs-catalog-accordion-rcl

v0.1.15

Published

This is a React component that renders a catalog accordion. It is used to display a list of items from DCS.

Downloads

312

Readme

DCS Catalog Accordion RCL

This is a React component that renders a catalog accordion. It is used to display a list of items from DCS.

Clone the Repository

To clone the repository, run the following command:

git clone https://github.com/unfoldingWord/dcs-catalog-accordion.git

Installation

To install the dependencies and build the project, we recommend using pnpm. If you don't have pnpm installed, you can install it by running:

npm install -g pnpm

Once pnpm is installed, navigate to the project directory and run the following command to install the dependencies:

pnpm install

Development

To run the development server, use the following command:

pnpm dev

This will start the development server and you can view the component in your browser at http://localhost:3000.

Usage as a 3rd Party App

To use DcsCatalogAccordion as a 3rd party app, follow these steps:

  1. Install the package from npm:
npm install dcs-catalog-accordion
  1. Import the component into your project:
import { DcsCatalogAccordion } from 'dcs-catalog-accordion';
  1. Use the component in your code:
<DcsCatalogAccordion
  languages={['en', 'fr']}
  owners={['unfoldingWord', 'Door43-Catalog']}
  subjects={['Aligned Bible', 'TSV Translation Notes']}
  stage="prod"
  dcsApiUrl="https://git.door43.org/api/v1"
/>

Props

The DcsCatalogAccordion component accepts the following props:

  • languages (optional, defaults to all languages): An array of strings representing the languages to filter the catalog items.
  • owners (optional, defaults to all owners): An array of strings representing the owners to filter the catalog items.
  • subjects (optional, defaults to all subjects): An array of strings representing the subjects to filter the catalog items.
  • stage (optional, defaults to "prod"): A string that can be either "prod" (all releases), "latest" (master and all releases), or "other" (all branches, not just master) to specify the stage of the catalog items.
  • dcsApiUrl (optional, defaults to https://git.door43.org/api/v1): A string representing the URL of the DCS API.

License

This project is licensed under the MIT License.