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

react-gm3carousel

v0.1.0

Published

Google Material 3 Carousel in React

Downloads

14

Readme

Google Material Design v3 Carousel for React!

Preview

Alt Text

Usage instructions

Step 1. install (npm/bun)

npm i react-gm3carousel
bun i react-gm3carousel
...

Step 2. import

 import { GM3Carousel } from "react-gm3carousel";
 // below could be optional, if you're already using TailwindCSS in your project, but you should add it regardless
 import "react-gm3carousel/dist/index.css";

Step 3. Use the carousel properly

Ensure your carousel is wrapped in an element with set width/height otherwise it ain't gonna show.

<div  style={{ width:  600, height:  240, background:  "red" }}>
	<GM3Carousel
		perPage={4}
		speedS={2}
		slides={DATA.map((d, idx) => ({
		content:  <p>Slide {idx}</p>,
		key:  d.id,
		}))}
	/>
</div>

Props

{
	// vertical vs horizontal carousel
	isVertical?: boolean;

	// wrapper class name
	className?: string;

	// what to render inside each slide
	slides: { content: ReactNode; key: string }[];

	speedS: number;

	// how moany slide to render per page
	perPage: number;

	// will have 4 small previews vs 2
	withDualSmallItems?: boolean;

	// class name for wrapper of small items
	smallItemClassName?: string;

	// class name for wrapper of large items
	bigItemClassName?: string;

	// auto scroll pause
	isPaused?: boolean;

	pauseOnMouseEnter?: boolean;

	slideWrapperClassName?: string;
}

Notes

You can target active slides with the blow selector

[data-active="true"] {}

You can set a gap either by

gap={16}

or through class names (notice first/last child margins match the gap)

gap-2 [&>*:last-child]:-ml-2 [&>*:first-child]:-mr-2

Important

The number of slideItems should be > than the perPage + 2, otherwise the transition animations might not work properly as there will be duplicate render issues due to React and how it might mess up tracking these items since the key will be duplicated.

Learn more

More about the official spec:

https://m3.material.io/components/carousel/specs