sitegeist/monocle-proptypes

Last activity 10 Jan 2023 2 21719
composer require sitegeist/monocle-proptypes

An addon for Sitegeist.Monocle that generates a rich prop editor configuration from PackageFactory.AtomicFusion.PropTypes

Sitegeist.Monocle.PropTypes

An addon for Sitegeist.Monocle that generates a rich prop editor configuration from PackageFactory.AtomicFusion.PropTypes

ScreenShot of @propTypes configuration in Fusion

⬇️ ⬇️ ⬇️

ScreenCast Sitegeist.Monocle with rich prop editor configuration

Sitegeist.Monocle.PropTypes is a zero-configuration addon for Sitegeist.Monocle that scans your @propTypes annotation and provides the Monocle UI with a corresponding prop editor configuration.

Authors & Sponsors

The development and the public-releases of this package was generously sponsored by our customer https://www.cornelsen.de and our employer https://www.sitegeist.de.

Installation

composer require sitegeist/monocle-proptypes

Prop Editors

PropType Editor
PropTypes.boolean CheckBox
PropTypes.string Text
PropTypes.integer Text, but cast to integer
PropTypes.float Text, but cast to float
PropTypes.oneOf SelecBox (with options that match the arguments of oneOf)
PropTypes.anyOf Provides the editor for the first PropType within its arguments

Configuration

You don't need to configure anything for Sitegeist.Monocle.PropTypes to work. In rare cases however, it might be that the PropTypes validator factory from PackageFactory.AtomicFusion.PropTypes (that is usually found under the context name PropTypes) is linked under a different context name.

In that case, you can provide the differing context name in the configuration for this package like this:

Sitegeist:
  Monocle:
    PropTypes:
      fusionContextName: 'MyCustomPropTypesContext'

Contribution

We will gladly accept contributions. Please send us pull requests.

License

See LICENSE

The content of the readme is provided by Github
The same vendor provides 48 package(s).