Skip to content
master
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.

README.md

sparkles-decorators

This addon provides decorators for Sparkles/Glimmer components to handle arguments in a nice way.

Sparkle Components is a proof-of-concept to Glimmer Components to use them in ember projects for early adopters.

Installation

ember install sparkles-decorators

Usage

In your component:

// src/ui/components/my-component/component.ts
import Component from 'sparkles-component';
import { arg } from 'sparkles-decorators';

interface Args {
  foo?: string;
  bar?: string;
}

export default class MyComponent extends Component<Args> {
  // default using object descriptor
  @arg({default: 'bar'}) foo!: string;

  // default using initializer
  @arg bar!: string = 'baz';
}
{{! src/ui/components/my-component/template.hbs}}
{{this.foo}}
{{! src/ui/routes/application/template.hbs}}

<MyComponent /> {{! prints 'bar'}}

Use the @arg decorator to bind properties to arguments (one-way). If an initializer is present, that will be used for your default value. Alternatively, you can pass a default value (or function) in the descriptor object which will be assigned to the property if none is set.

You can also specify the name of your argument (if property and name are different):

export default class MyComponent extends Component {
  @arg({name: 'foo'}) bam!: string;
}

// shorthand code (since 0.0.3):
export default class MyComponent extends Component {
  @arg('foo') bam!: string;
}
{{! src/ui/components/my-component/template.hbs}}
{{this.bam}}
{{! src/ui/routes/application/template.hbs}}

<MyComponent @foo='bar'/> {{! prints 'bar'}}

API

aliased

@arg(name?)

name (optional) - the name of the argument

config options

@arg(options?)

options.name (optional) - the name of the argument
options.default (optional) - the default value or function

License

This project is licensed under the MIT License.

You can’t perform that action at this time.