Skip to content

Commit

Permalink
Tidy up types/README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
stevepiercy committed Mar 4, 2024
1 parent 2da86a2 commit 931ce66
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions packages/types/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,20 @@

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 publised "as it is", so you can import the type definitions from anywhere in your code.
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:

This files are organised 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)

- 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 RESTAPI services)

## Extending existing types in this package in your projects

Expand All @@ -30,8 +32,9 @@ declare module '@plone/types' {
}
```


## Compatibility

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

0 comments on commit 931ce66

Please sign in to comment.