Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

ember-prop-types

ciena-blueplanet11kMIT9.0.2

This addon provides React-like property management for components.

ember-addon

readme

ember-prop-types

This addon provides React-like property management for components.

Dependencies

Ember NPM

Health

Travis Coveralls

Security

bitHound

Installation

ember install ember-prop-types

Usage

Full Docs

Examples

Better Components

Below is an example of a component that uses the property mixin provided by this addon:

import Ember from 'ember'
import {PropTypes} from 'ember-prop-types'

export default Ember.Component.extend({
  propTypes: {
    foo: PropTypes.string,
    bar: PropTypes.number.isRequired,
    baz: PropTypes.oneOfType([
      PropTypes.bool,
      PropTypes.string
    ])
  },

  getDefaultProps () {
    return {
      foo: 'This is going to be highly profitable'
    }
  }
})

If this mixin is being used in a class other than Component, it will need to be mixed into the class:

import Ember from 'ember'
import PropTypeMixin, {PropTypes} from 'ember-prop-types'

export default Ember.ClassName.extend(PropTypeMixin, {
  propTypes: {
    foo: PropTypes.string,
    bar: PropTypes.number.isRequired,
    baz: PropTypes.oneOfType([
      PropTypes.bool,
      PropTypes.string
    ])
  },

  getDefaultProps () {
    return {
      foo: 'This is going to be highly profitable'
    }
  }
})

Property Validation

The idea of propTypes comes from the world of React and is implemented to have an almost identical API in the Ember world. Below is a list of possible propTypes to validate against.

  • any
  • array
  • arrayOf
  • bool
  • date
  • element
  • EmberObject
  • func
  • instanceOf
  • null
  • number
  • object
  • oneOf
  • oneOfType
  • regexp
  • shape
  • string
  • symbol

Default Property Values

In Ember you can set default property values on a component class itself but sometimes this bites you when you end up with a property containing an array of selected items or a state object, where all instances of the component end up sharing that same array or object. Uncovering this issue is not always an easy task and so getDefaultProps was also implemented (thanks to the React team for this concept as well).

changelog

9.0.2 (2018-10-11)

  • Update PUBLISH_NODE_VERSION to 10.7.0

9.0.1 (2018-10-11)

  • Update PUBLISH_NODE_VERSION to 10.7.0

9.0.0 (2018-10-04)

  • Run es5 getter codemod

8.0.0 (2018-09-20)

Dependencies:

  • Updated core dependencies to be compatible with ember 3.3.
  • Updated third-party dependencies to be compatible with ember 3.3.

Addon:

  • Updated Ember core module import paths to match Ember.js new Modules API.
  • Replaced Ember.Logger with the native console.

Testing:

  • Removed helpers/resolver.js, helpers/start-app.js, helpers/destroy-app.js as they are not needed with Ember new testing API.
  • Updated test-helper.js to align with Ember's new testing API.
  • Added Ember 3.3 scenario to ember-try config.

7.0.5 (2018-08-20)

  • Fixed Travis API key.

7.0.4 (2018-07-20)

  • Fixed Travis API key.

7.0.3 (2018-04-26)

  • Updated ember-component validator to work with Ember CLI 3.2.0

7.0.2 (2018-03-09)

  • Updated ember-spread devDependency to ^5.0.0

7.0.1 (2018-03-09)

  • Updated pull request template
  • Added issue template
  • Updated to pr-bumper version 3
  • Updated to node 8
  • Added slack integration
  • Updated ember-frost-test to ^4.0.1
  • Updated ember-test-utils to ^8.1.1
  • Updated ember-cli-frost-blueprints to ^5.0.2
  • Added package-lock.json file

7.0.0 (2018-02-19)

  • Updated test helper to now be provided from addon-test-support. For example, the createComponent test helper previously available at dummy/tests/helpers/ember-prop-types is now available via ember-prop-types/test-support/utils

6.0.1 (2018-01-03)

  • Update ember-spread devDependency to ^4.0.1

6.0.0 (2018-01-03)

  • Update ember-cli-google-fonts to ^2.16.2
  • Pin ember-cli-htmlbars-inline-precompile to 0.3.12
  • Pin ember-get-config to 0.2.2
  • Move ember-string-ishtmlsafe-polyfill to dependency
  • Remove npm-install-security-check dependency
  • Pin prism Bower dependency to 1.6.0
  • Remove useLintTree ember-cli-mocha configuration
  • Upgrade ember-frost-test to ^4.0.0
  • Install ember-cli-frost-blueprints@^5.0.1
  • Git ignore package-lock.json file until officially support Node 8
  • Upgrade ember-spread to ^3.0.1

5.0.3 (2017-12-27)

We experienced an issue with our release version strategy and this release should not have occurred. It should have been part of 6.0.0

5.0.2 (2017-11-22)

  • Updated to use latest version of ember-frost-test
  • Updated to use latest version of ember-test-utils
  • Added bower package since it is no longer included by Ember CLI
  • Updated lint to skip linting of line length in CHANGELOG.md file

5.0.1 (2017-11-02)

  • Update ember-spread to Ember CLI 2.12.3 compatible version as part of reversion from Ember CLI 2.16.1 to 2.12.3

5.0.0 (2017-11-02)

WARNING: THIS REVERTS EMBER CLI 2.16.1 BACK TO 2.12.3

We apologize for this change. Unfortunately, due to the internal needs of our organization this became a required action.

The 2.16.1 changes are now located in the ember-cli-2.16.1 branch and will hopefully be contained in a versioned release again in the future.

4.1.0 (2017-10-30)

  • Added regexp type

4.0.1 (2017-10-11)

  • Updated to Ember CLI 2.16.1

4.0.0 (2017-09-27)

  • Updated to Ember CLI version 2.15.1 (uses babel 6)
  • Updated imports to ember javascript modules syntax
  • Added eslint rule to require usage of new modules syntax (will remove once added to ember-test-utils)
  • Updated test helpers to now come from addon-test-support
  • Updated ember-cli-code-coverage and configured reporters
  • Removed ember-string-ishtmlsafe-polyfill - If running Ember CLI < 2.8 then add back to your consuming addon/app.

3.14.2 (2017-09-25)

  • Adds a fallback for Object.assign for browsers that don't support it (i.e. IE).

3.14.1 (2017-08-02)

  • Install ember-string-ishtmlsafe-polyfill to address #139

3.14.0 (2017-08-02)

Update string validation to support Ember SafeString objects. Fixes #128.

3.13.4 (2017-07-10)

  • Fix ember-component validator usage in ember#lts-2-8 branch of Ember

3.13.3 (2017-07-10)

Upgrade ember-cli to 2.12.3

3.13.2 (2017-07-04)

  • Upgrade ember-get-config

3.13.1 (2017-07-04)

  • Fix HTMLBars linting

3.13.0 (2017-06-23)

  • Added date type

3.12.3 (2017-06-01)

fixed error with nameOfType if typedef does not return a function string

3.12.2 (2017-05-30)

  • Fixed a regression in the execution order of getDefaultProps introduced in #118

3.12.1 (2017-05-10)

  • Updated the secure auth tokens in .travis.yml

3.12.0 (2017-04-24)

  • Fixed build.

3.11.0 (2017-04-03)

  • Log typeOf value when asserting type

3.10.4

  • Upgraded ember-get-config.

3.10.3

  • Fixed EmberComponent prop type to work properly with Glimmer 2.

3.10.2

  • Upgraded to test against Ember 2.11.

3.10.1

  • Attempt to fix publishing of dummy app to gh-pages branch.

3.10.0

  • Added additional builds to CI to make sure addon works with latest versions of Ember.
  • Removed files from npm package that aren't necessary (all of the various config files).
  • Updated dependencies to latest versions.

3.9.0

  • Added new updatable option to all types to flag components that shouldn't allow updates. By default all properties will allow updates so specifying updatable: true isn't necessary.

3.8.0

  • Added EmberComponent prop-type for properties that come from the {{component}} helper.

3.7.1

  • Fixed typo in dummy app.

3.7.0

  • Added new alternative API for the following types:

    • any
    • array
    • bool
    • element
    • EmberObject
    • func
    • null
    • number
    • object
    • string
    • symbol

    Example of new API with any type

    bar: PropTypes.any(), // Same as PropTypes.any
baz: PropTypes.any({required: true}), // Same as PropTypes.any.isRequired
foo: PropTypes.any({required: false}) // same as PropTypes.any

    NOTE: If you update an addon to use this new API, consumers of your addon will also need to be upgraded to the version of ember-prop-types that includes this API. Otherwise they'll see errors as PropTypes.any() won't work due to the fact any will be an object rather than a function.

  • Added new optional argument to the following types:

    • arrayOf
    • instanceOf
    • oneOf
    • oneOfType
    • shape

    Example of new optional argument with arrayOf type

    baz: PropTypes.arrayOf(PropTypes.string, {required: true}), // Same as PropTypes.arrayOf(PropTypes.string).isRequired
foo: PropTypes.arrayOf(PropTypes.string, {required: false}) // same as PropTypes.arrayOf(PropTypes.string)

3.6.0

  • Added the ability to enable/disable validation from an environment configuration setting, allowing consumers to control which environments ember-prop-types warnings/errors appear in. Below is an example of how to explicitly enable validation:

    'ember-prop-types': {
  validate: true
}

    Note: Without explicitly adding this setting things will continue to work as they did before in which validation is enabled for all environments except production.

  • Fixed validation error messages when throwErrors is set to true to match error messages when errors are not thrown (logging warnings instead).

3.5.0

  • Added ability to validate properties on initialized that are nested under a single property via something like ember-spread.

3.4.0

  • Added the ability to configure validation errors to be throw as errors instead of logged as warnings. To enable this feature simply add the following to config/environment.js:

    'ember-prop-types': {
  throwErrors: true
}

3.3.0

  • Added opt-in validation checks when properties that are spec'd in propTypes are updated. To enable this feature simply add the following to config/environment.js:

    'ember-prop-types': {
  validateOnUpdate: true
}

3.2.1

  • Fixed bug where defaults weren't being applied when consumer passes in undefined for a property with defaults.

3.2.0

  • Added more detailed messaging for sub-property validations when using PropTypes.arrayOf or PropTypes.shape

3.1.1

  • Fixed a bug in the PropTypes.arrayOf validator when used in conjunction with the PropTypes.shape validator.

3.1.0

3.0.2

  • Improved demo by adding license, link to Github repository, contributors, syntax highlighting, and a brief summary.

3.0.1

  • Added dummy app for better documentation.

3.0.0

  • Support cases where components and mixins both use this mixin.

2.5.11

  • Added pull request template.

2.5.10

  • Added npm-install-security-check as a dependency to make consumers more security conscious.

2.5.9

  • Updated CI configuration to not run npm scripts on install.

2.5.8

  • Cleaned up README to pass default config for remark-lint and better organized badges.
  • Updated dev dependencies.

2.5.7

2.5.6

  • Updated Travis configuration to test addon against older versions of Ember.

2.5.5

  • Only import polyfill for CI and not for consuming apps. Apps that want Symbol can pay as they go.

2.5.4

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.5.3

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.5.2

  • Fixed issue when Ember.assign does not exist to fallback on Object.assign then Ember.merge.

2.5.1

  • Addedd missing prop-types to README.
  • Upgraded ember-get-config to latest version.

2.5.0

  • Added element prop-type.

2.4.2

  • Added symbol prop-type.

2.4.1

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.4.0

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.3.1

  • Fixed shape prop-type to not error when non-required props in shape are not present.

2.3.0

  • Added arrayOf prop-type.

2.2.8

  • Split source code up into separate modules as a first step in refactoring and improving implementation.

2.2.7

  • Added tests for oneOf prop-type.

2.2.6

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.2.5

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

2.2.4

  • Added tests for instanceOf prop-type.

2.2.3

  • Added tests for shape prop-type and commented out tests that exercise issue #24.

2.2.2

  • Added a bunch of tests to help prevent future regressions and verify addon does what it advertises.

2.2.1

  • Finishes the removal of lodash as a dependency
  • Removed Object.assign to fix cases where browsers don't support the latest ES6 syntax

2.2.0

  • Removed lodash as a dependency to avoid lodash as a downstream requirement
  • Replaced lodash functions with equivalent Ember/ES6/custom functions

2.1.0

  • Changed from ember-lodash to ember-lodash-shim.

2.0.1

  • Updated dependencies to the latest versions.

2.0.0

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

1.5.0

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md

1.4.0

No CHANGELOG section found in Pull Request description. Use a # CHANGELOG section in your Pull Request description to auto-populate the CHANGELOG.md