https://github.com/gossi/sparkles-decorators

Decorators for Sparkles/Glimmer Components
https://github.com/gossi/sparkles-decorators

Last synced: 15 days ago
JSON representation

Decorators for Sparkles/Glimmer Components

• Host: GitHub
• URL: https://github.com/gossi/sparkles-decorators
• Owner: gossi
• License: mit
• Created: 2018-08-06T13:29:16.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2019-01-12T13:43:18.000Z (almost 6 years ago)
• Last Synced: 2024-10-03T12:27:53.040Z (about 1 month ago)
• Language: JavaScript
• Size: 212 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-ember - sparkles-decorators - Decorators for Sparkles/Glimmer.js Components. (Packages / ES6)

README

        
# sparkles-decorators

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

[Sparkle Components](https://github.com/rwjblue/sparkles-component) 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:

```ts

// 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 {

  // default using object descriptor

  @arg({default: 'bar'}) foo!: string;

  // default using initializer

  @arg bar!: string = 'baz';

}

```

```hbs

{{! src/ui/components/my-component/template.hbs}}

{{this.foo}}

```

```hbs

{{! src/ui/routes/application/template.hbs}}

 {{! 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):

```ts

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;

}

```

```hbs

{{! src/ui/components/my-component/template.hbs}}

{{this.bam}}

```

```hbs

{{! src/ui/routes/application/template.hbs}}

 {{! 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](LICENSE.md).