Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update readme for Ember Octane #140

Merged
merged 3 commits into from
Mar 12, 2020
Merged

Conversation

jelhan
Copy link
Contributor

@jelhan jelhan commented Oct 16, 2019

Updates the readme for Ember Octane. In detail it does:

  • Refactor curly bracket component invocation to angle bracket syntax.
  • It remove duplicated examples (curly + angle bracket). It's not necessary anymore in my opinion as there isn't anything special about conversion for this addon. It does neither use positional params in curly invocation nor require special arguments for the mapping to HTML attributes.
  • Use {{on}} element modifier for event binding instead of {{action}}.
  • Uses native classes in the example.
  • Use @action decorator instead of actions hash in the examples.

README.md Outdated Show resolved Hide resolved
@@ -152,24 +127,15 @@ Using angle bracket invocation:

Two arguments are passed to the block: `message` object, and `close` action. Make sure
you are using *Closure Actions* syntax passing the action (e. g. `<a {{action close}}` or
`{{your-component close=(action close)}}`.
`<YourComponent @close={{action close}} />`.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this binding should be done internally using @action decorator to drop that requirement and simplify to <YourComponent @close={{close}} />. But will leave that one for another PR.

README.md Outdated Show resolved Hide resolved
@btecu
Copy link
Member

btecu commented Oct 16, 2019

Thanks! Overall looks good. I'll wait until Octane is released before merging.

@jelhan
Copy link
Contributor Author

jelhan commented Oct 16, 2019

@btecu Thanks for your review! Addressed the comments. Do you want me to squash or will you squash it when you merge the PR anyway?

@jelhan jelhan changed the title update readme for reflect Ember Octane update readme for Ember Octane Oct 16, 2019
@btecu
Copy link
Member

btecu commented Oct 16, 2019

@jelhan I can squash when merging.

@btecu btecu merged commit 5d711d4 into adopted-ember-addons:master Mar 12, 2020
@btecu
Copy link
Member

btecu commented Mar 12, 2020

Thanks @jelhan!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants