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

@plone/types

v1.0.0

Published

Plone's Types Package

Downloads

1,939

Readme

@plone/types

Plone unified TypeScript typings.

Rules while developing this package

This package contains .d.ts typing definitions, curated by hand. Due to the nature of this package, it does not need bundling. It's published "as is", so you can import the type definitions from anywhere in your code.

The files are organized in the following way:

  • blocks (props related to blocks and blocks components)
  • config (configuration object typings)
  • content (content releated and serialization of the content objects)
  • services (typings concerning Plone REST API services)

Extending existing types in this package in your projects

In a project, you often need to extend the default definitions with your own, for example, when dealing with custom content types or creating new blocks.

You can use TypeScript for extending the types like this:

// We extend the block types with our custom ones
declare module '@plone/types' {
  export interface BlocksConfigData {
    myCustomBlock: BlockConfigBase;
  }
}

Compatibility

You can use this package from Volto 17 onwards. In Volto 17, you should declare it as dependency. In Volto 18 and later, it is included by default.