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

@volusion/element-block-utils

v2.11.0

Published

## What are the utils?

Downloads

33

Readme

element-block-utils

What are the utils?

joinClasses

This util is provided as an alternative to using the joinClasses prop passed to blocks by the SDK on some block contracts. Read more about what this helper does and why you should use it here. It can be imported from @volusion/element-block-utils.

Usage at the block level.
import React from 'react';
import { joinClasses } from '@volusion/element-block-utils';
import { css, StyleSheet } from 'aphrodite';
import { getStyles } from './getStyles';

export const YourBlock = props => {
    const styles = StyleSheet.create(getStyles(props));
    return (
        <div className={joinClasses('w-100 center', css(styles.wrapper))}>
            {/* Your content */}
        </div>
    );
};

If your block is using the joinClasses prop provided by the SDK, you can simplify your imports into your test files by importing it from @volusion/element-block-utils/test-utils. If your block is importing joinClasses, you do not need to add it to your tests.

import React from 'react';
import { joinClasses } from '@volusion/element-block-utils/test-utils';

let props;
describe('The block', () => {
    beforeEach(() => {
        props = {
            joinClasses
        };
    });
    it('should match the snapshot', () => {
        const wrapper = mount(<Block {...props} />);
        expect(wrapper.render()).toMatchSnapshot();
    });
});

mockUtils

This util provides a full jest mock of the SDK utils that are passed to your block as the util prop. It can be imported from @volusion/element-block-utils/test-utils;

Usage example:
import React from 'react';
import { mockUtils as utils } from '@volusion/element-block-utils/test-utils';

let props;
describe('The block', () => {
    beforeEach(() => {
        props = {
            utils
        };
    });
    it('should match the snapshot', () => {
        const wrapper = mount(<Block {...props} />);
        expect(wrapper.render()).toMatchSnapshot();
    });
});

Deprecated utils

The following utils have been deprecated and should no longer be used. They are only provided here as a knowledge resource for blocks built on older contracts.

createFactory

This util wraps old blocks in a React factory function required by older block contracts.

Release process

  1. Bump the version number on package.json and package-lock.json and commit.
  2. Merge PR.
  3. Tag latest on master and push.
  4. Create to release from newly created tag. This will automatically release to npm.