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

@degjs/storybook-decorator-sitecoreprops

v1.0.4

Published

A Storybook decorator for normalizing Sitecore JSS props

Downloads

57

Readme

storybook-decorator-sitecoreprops

SitecoreProps is a Storybook addon for normalizing nested Sitecore JSS field props.

Why does this exist?

Sitecore JSS does a great job of putting front-end developers in the driver's seat of project development, but it does have a few quirks. One of those is the fields prop that must be passed to its provided JSS React content components, which expects an object formatted like this:

{
  fields: {
    heading: {
      value: 'Value'
    }
  }
}

In practice, that means passing props like this:

import { Text } from '@sitecore-jss/sitecore-jss-react';

const CustomComponent = ({fields}) => (
  <div className="custom-component">
    <Text fields={fields.heading} />
  </div>
);

export default CustomComponent;

This structure can create pretty verbose sample data structures in Storybook stories. To combat this, the SitecoreProps decorator will automatically decorate stories to build out the nested value object whenever a fields property is passed to it. That means you can write sample data like this, without worrying about the extra layer of nesting:

{
  fields: {
    heading: 'Value'
  }
}

Installation

Install the following npm module in your project:

npm i --save-dev @degjs/storybook-decorator-sitecoreprops

To install for all stories, import withSitecoreProps and add the decorator within .storybook/preview.js, like this:

import { addDecorator } from '@storybook/react';
import { withSitecoreProps } from '@degjs/addon-sitecoreprops/';

addDecorator(withSitecoreProps);