npmpackage.info

Gathering detailed insights and metrics for pretty-proptypes

Other packages similar to pretty-proptypes

@types/pretty-proptypes

1.1.4

TypeScript definitions for pretty-proptypes

api-check

7.5.5

Validate the api to your functions to help people use them correctly. This is pretty much React's propTypes without React.

babel-plugin-extract-react-types

0.2.0

Plugin to allow pretty-proptypes to more easily pull in component data

Gathering detailed insights and metrics for pretty-proptypes

pretty-proptypes

One stop shop for documenting your react components.

1.7.0

184

MIT

JavaScript

422.47 kB

4.6

Installations

npm install pretty-proptypes

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

14.18.0

NPM Version

6.14.15 Pull Requests

Open

14

Total

225

Closed

34

Merged

177

Issues

Open

19

Total

44

Closed

25

Releases

pretty-proptypes@1.3.0

Updated on Jul 04, 2021

extract-react-types-loader@1.0.0

Updated on Jun 09, 2021

extract-react-types@0.30.2

Updated on May 25, 2021

extract-react-types@0.30.1

Updated on Apr 20, 2021

pretty-proptypes@1.2.0

Updated on Mar 08, 2021

extract-react-types@0.30.0

Updated on Mar 05, 2021

View All 26 releases

Languages

JavaScript

TypeScript

JavaScript (99.71%)

TypeScript (0.29%)

Developer

atlassian

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

184 Stars

288 Commits

29 Forks

5 Watchers

52 Branches

79 Contributors

Updated on Jul 10, 2025

Maintainers

View All 79 Contributors

Package Meta Information

Latest Version

1.7.0

Package Id

pretty-proptypes@1.7.0

Unpacked Size

422.47 kB

Size

67.61 kB

File Count

NPM Version

6.14.15

Node Version

14.18.0

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

PrettyPropTypes

PrettyPropTypes is designed to display the output of extract-react-types. It is designed to read the output from extract-react-types, and display rich prop information for consumers.

Core usage pattern

pretty-proptypes can display props from two sources.

Using babel-plugin-extract-react-types and passing the component to Props

.babelrc

1{
2  "plugins": ["babel-plugin-extract-react-types"]
3}

1import MyCoolComponent from '../MyCoolComponent';
2
3<Props heading="My Cool Component" component={MyCoolComponent} />;

Directly passing a component's props to Props with extract-react-types-loader or getting types from extract-react-types and writing it to a file

1<Props
2  heading="My Cool Component"
3  props={require('!!extract-react-types-loader!../MyCoolComponent')}
4/>

This analyses prop type definitions, and default props. It creates descriptions from comments before the type definitions, and will render markdown syntax using react-markings.

Quick Tips

Using babel-plugin-extract-react-types is definitely the easiest way to get this information from your components, however you can use extract-react-types-loader or prebuild this data with extract-react-types and read it from a file if you prefer.
When using extract-react-types directly or extract-react-types-loader, they will currently only look at the default export of a file. babel-plugin-extract-types will look at the default export as well as named exports.

Customisation Props

Heading

Display a heading for the collection of props. Pass in an empty string if you want no heading, otherwise it defaults to "Props".

shouldCollapseProps

Set whether the prop shapes should be shown by default, or whether they should be hidden, and require being expanded.

Components

Accepts an object that allows you to override particular style components within our prop definition. The currently modifiable components are:

Indent
Outline
Required
Type
StringType
TypeMeta

Any that are not passed in will use the default component.

Overrides

The override prop allows you to override a specific prop's definition. If you want to keep the appearance aligned, we recommend using the Prop export from PrettyPropType.

An override is invoked with all the props passed to the Prop component internally, and renders the result. In the example below, we are changing the type field, and stopping the shape component from appearing, while leaving other parts of the component the same.

1import Props, { Prop } from 'pretty-proptypes'
2
3${<Props
4  heading=""
5  props={require('!!extract-react-types-loader!../../PropTypes/Select')}
6  overrides={{
7    isACoolComponent: (props) => <Prop {...props} shapeComponent={() => null} type="All Components Object" /> }}
8/>}

While you can pass style components directly to Prop, we recommend passing style components in the top level Props, and letting them flow down.

Custom layouts

In cases where a completely bespoke layout is required, use the LayoutRenderer. This component allows you to define a completely custom layout and substitute in your own UI.

The renderTypes prop is called for every prop found on a given component and allows you to specify how that type should be rendered.

If you don't want to override the default components, you can use the components property. Or import them directly from pretty-proptypes.

1import { LayoutRenderer } from 'pretty-proptypes';
2
3<LayoutRenderer
4  props={require('!!extract-react-types-loader!../MyCoolComponent')}
5  renderTypes={({ typeValue, defaultValue, description, required, name, type, components }) => {
6    <div>
7      <h2>{name}</h2>
8      <components.Description>{description}</components.Description>
9      {required && <components.Required>Required</components.Required>}
10      <components.Type>{type}</components.Type>
11      <components.PropType typeValue={typeValue} />
12    </div>;
13  }}
14/>;

No vulnerabilities found.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

9

Maintained

Determines if the project is "actively maintained".

7

SAST

Determines if the project uses static code analysis.

5

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

4

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

4.6

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More

pretty-proptypes - 1.7.0 | npmpackage.info

Other packages similar to pretty-proptypes

Other packages similar to pretty-proptypes

pretty-proptypes

Installations

Developer Guide

No

CommonJS

14.18.0

6.14.15

Pull Requests

14

225

34

177

Issues

19

44

25

Releases

Languages

Developer

Download Statistics

GitHub Statistics

Maintainers

Package Meta Information

Total Downloads

NaN

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

PrettyPropTypes

Core usage pattern

Quick Tips

Customisation Props

Heading

shouldCollapseProps

Components

Overrides

Custom layouts

10

10

10

9

7

5

4

0

0

0

0

0

0

4.6

/10