open-consul/ui/packages/consul-ui/app/components/ref
Michael Klein 048572946c
ui: chore - upgrade ember and friends (#14518)
* v3.20.2...v3.24.0

* Fix handle undefined outlet in route component

* Don't use template helper for optional modal.open

Using the optional-helper here will trigger a computation
in the same runloop error. This is because we are setting
the `modal`-property when the `<Ref>` component gets
rendered which will update the `this.modal`-property which
will then recompute the `optional`-helper leading to this
error.

Instead we will create an action that will call the `open`-method
on the modal when it is defined. This gets rid of the double
computation error as we will not access the modal property
twice in the same runloop when `modal` is getting set.

* Fix - fn needs to be passed function tab-nav

We create functions in the component file instead
so that fn-helper stops complaining about the
need to pass a function.

* Update ember-exam to 6.1 version

"Makes it compatible" with ember-qunit v5

* scheduleOnce setMaxHeight paged-collection

We need to schedule to get around double-computation error.

* Fix - model.data is removed from ember-data

This has been private API all along - we need to
work around the removal.

Reference: https://github.com/emberjs/data/pull/7338/files#diff-9a8746fc5c86fd57e6122f00fef3155f76f0f3003a24b53fb7c4621d95dcd9bfL1310

* Fix `propContains` instead of `deepEqual` policy

Recent model.data works differently than iterating attributes.
We use `propContains` instead of `deepEqual`. We are only
interested in the properties we assert against and match
the previous behavior with this change.

* Fix `propContains` instead of `deepEqual` token

* Better handling single-records repo test-helper

`model.data` has been removed we need to handle proxies and
model instances differently.

* Fix remaining repository tests with propContains

We don't want to match entire objects - we don't care
about properties we haven't defined in the assertion.

* Don't use template helper for optional modal.open

Using a template helper will give us a recomputation error -
we work around it by creating an explicit action on
the component instead.

* Await `I $verb the $pageObject object` step

* Fix no more customization ember-can

No need to customize, the helper handles destruction
fine on its own.

* Fix - don't pass `optional` functions to fn

We will declare the functions on the component instead.
This gives us the same behavior but no error from
`fn`, which expects a function to be passed.

* Fix - handle `undefined` state on validate modifier

StateChart can yield out an undefined `state` we need
to handle that in the validate modifier

* Fix linting errors tests directory

* Warn / turn off new ember linting issues

We will tackle them one by one and don't want to
autofix issues that could be dangerous to auto-fix.

* Auto-fix linting issues

* More linting configuration

* Fix remaining linting issues

* Fix linting issues new files after rebase

* ui: Remove ember-cli-uglify config now we are using terser (#14574)

Co-authored-by: John Cowen <johncowen@users.noreply.github.com>
2022-09-15 09:43:17 +01:00
..
README.mdx
index.js ui: chore - upgrade ember and friends (#14518) 2022-09-15 09:43:17 +01:00

README.mdx

---
class: ember
---
# Ref

`<Ref @target={{this}} @name="api" @value={{api}} />`

| Argument | Type | Default | Description |
| --- | --- | --- | --- |
| `target` | `Object` | | The object to assign the property/value to |
| `name` | `String` | | The property name |
| `value` | `Object` |  | The value |

`<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.

Occasionally it's necessary call actions belonging to a component from outside the component. For example, you may have a form that needs submitting by clicking a button in another area of the
page. In order to do this, the button needs access to the `submit` action of the form component.

This can be thought of as providing the public API for the component, the author of the component has control over what the user of the component can and can't call in this way.

### Example

Here we provide a public API for a form component whilst authoring.

```hbs
{{! /components/form/index.hbs }}
<form onsubmit={{action "submit"}}>
  {{yield (hash
    focus=(action "focus")
    submit=(action "submit")
    cancel=(action "cancel")
  )}}
  ...
  <button type="submit">Submit</button>
</form>
```

The user of the component now has access to the public API of the ember/glimmer `<Form>` component, in the same way that using the `{{ref}}` modifier gives the user access to the public API of native DOM elements (for example `<input {{ref this 'input'}}/>` / `this.input.focus()`).

```hbs
{{! /templates/index.hbs}}
<Form as |api|>
  <Ref @target={{this}} @name="form" @value={{api}} />
</Form>
...
<button type="button" onclick={{action this.form.submit}}}></button>
```

### See

- [Component Source Code](./index.js)

---