ui: Move <Ref /> docs to README.mdx (#7459)

README.mdx file are auto displayed in GH. Also added note on it being
renderless, which is useful to know from a CSS standpoint
This commit is contained in:
John Cowen 2020-03-17 13:29:34 +00:00 committed by John Cowen
parent 5e98ef3f51
commit 64b07dcafe
1 changed files with 2 additions and 2 deletions

View File

@ -8,7 +8,7 @@
| `name` | `String` | | The property name | | `name` | `String` | | The property name |
| `value` | `Object` | | The value | | `value` | `Object` | | The value |
`<Ref />` allows component users use an author defined public API of a component. `<Ref />` allows component users use an author defined public API of a component. The component is renderless in that it yields nothing to the DOM.
The component takes a property name and value and sets it on the specified target, similar to the `{{ref this "name"}}` modifier. The component takes a property name and value and sets it on the specified target, similar to the `{{ref this "name"}}` modifier.
@ -24,7 +24,7 @@ Here we provide a public API for a form component whilst authoring.
```handlebars ```handlebars
{{! /components/form/index.hbs }} {{! /components/form/index.hbs }}
<form onsubmit={{action "submit"}}> <form onsubmit={{action "submit"}}>
{{ yield (hash {{yield (hash
focus=(action "focus") focus=(action "focus")
submit=(action "submit") submit=(action "submit")
cancel=(action "cancel") cancel=(action "cancel")