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

preconf

v1.1.0

Published

Configure your components, easily.

Downloads

6

Readme

A Higher Order Component that provides configuration (from context & defaults) as props.

Preconf is just 400 bytes and works well with preact-context-provider.


Usage

import preconf from 'preconf';
import Provider from 'preact-context-provider';

// generally from an import
const defaults = {
	greeting: 'hello'
};

let configure = preconf(null, defaults);

/** Wire two configuration fields up to props: */
@configure('greeting, name')
class Foo extends Component {
	render({ greeting, name }) {
		return <span>{greeting}, {name}</span>
	}
}

/** Render from defaults: */
render(<Foo />);
// <span>hello, </span>

/** Provide overrides as `context.config`: */
render(
	<Provider config={{ name: 'Stan' }}>
		<Foo />
	</Provider>
);
// <span>hello, Stan</span>

API

Table of Contents

preconf

Creates a higher order component that provides values from configuration as props.

Parameters

  • namespace String? If provided, exposes defaults under a namespace
  • defaults Object? An object containing default configuration values

Examples

Decorate a component without any namespace or defaults

let configure = preconf();
export const MyConfiguredComponent = configure({ a: 'a' })(MyComponent);

MyConfiguredComponent.getWrappedComponent() === MyComponent; // true

Decorate a component without a namespace and using defaults

let configure = preconf(null, { url:'//foo.com' });
export default configure({ url: 'url' })( props =>
	<a href={props.url} />
);

Decorate a component with weather namespace and using defaults

let configure = preconf('weather', { url:'//foo.com' });
export default configure({
	url: 'weather.url'
})( ({ url }) =>
	<a href={props.url} />
);

Returns Function configure()

configure

Creates a Higher Order Component (HOC) that provides configuration as props.

Parameters
  • keys (Object | Array<String>) An object where the keys are prop names to pass down and values are dot-notated keypaths corresponding to values in configuration. If a string or array, prop names are inferred from configuration keys.

Returns Function configureComponent(Component) -> Component. The resulting HOC has a method getWrappedComponent() that returns the Child that was wrapped

License

FOSSA Status