Implement basic component API #14
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,5 +1,7 @@ | ||
| 'use strict'; | ||
|
|
||
| module.exports = { | ||
| plugins: ['prettier-plugin-ember-template-tag'], | ||
| singleQuote: true, | ||
| templateSingleQuote: false, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,26 @@ | ||
| # ember-headless-form | ||
|
|
||
| [Short description of the addon.] | ||
|
|
||
| ## Compatibility | ||
|
|
||
| - Ember.js v4.8 or above | ||
| - Embroider or ember-auto-import v2 | ||
|
|
||
| ## Installation | ||
|
|
||
| ``` | ||
| ember install ember-headless-form | ||
| ``` | ||
|
|
||
| ## Usage | ||
|
|
||
| [Longer description of how to use the addon in apps.] | ||
|
|
||
| ## Contributing | ||
|
|
||
| See the [Contributing](CONTRIBUTING.md) guide for details. | ||
|
|
||
| ## License | ||
|
|
||
| This project is licensed under the [MIT License](LICENSE.md). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,50 +1,6 @@ | ||
| 'use strict'; | ||
|
|
||
| const { configs } = require('@nullvoxpopuli/eslint-configs'); | ||
|
|
||
| // accommodates: JS, TS, App, and Addon | ||
| module.exports = configs.ember(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,4 +1,5 @@ | ||
| 'use strict'; | ||
|
|
||
| const { addonV1Shim } = require('@embroider/addon-shim'); | ||
|
|
||
| module.exports = addonV1Shim(__dirname); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| <input | ||
| type={{@type}} | ||
| value={{this.valueAsString}} | ||
| id={{@fieldId}} | ||
| ...attributes | ||
| {{on 'input' this.handleInput}} | ||
| /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,62 @@ | ||
| import Component from '@glimmer/component'; | ||
| import { assert } from '@ember/debug'; | ||
| import { action } from '@ember/object'; | ||
|
|
||
| // Possible values for the input type, see https://developer.mozilla.org/en-US/docs/Web/HTML/Element/input#input_types | ||
| // for the sake ok completeness, we list all here, with some commented out that are better handled elsewhere, or not at all... | ||
| export type InputType = | ||
simonihmig marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| // | 'button' - not useful as a control component | ||
| // | 'checkbox' - handled separately, for handling `checked` correctly and operating with true boolean values | ||
| | 'color' | ||
| | 'date' | ||
| | 'datetime-local' | ||
| | 'email' | ||
| // | 'file' - would need special handling | ||
| | 'hidden' | ||
| // | 'image' - not useful as a control component | ||
| | 'month' | ||
| | 'number' | ||
| | 'password' | ||
| // | 'radio' - handled separately, for handling groups or radio buttons | ||
| | 'range' | ||
| // | 'reset' - would need special handling | ||
| | 'search' | ||
| // | 'submit' - not useful as a control component | ||
| | 'tel' | ||
| | 'text' | ||
| | 'time' | ||
| | 'url' | ||
| | 'week'; | ||
|
|
||
| export interface HeadlessFormControlInputComponentSignature<VALUE> { | ||
| Element: HTMLInputElement; | ||
| Args: { | ||
| value: VALUE; | ||
| type?: InputType; | ||
| fieldId: string; | ||
| setValue: (value: VALUE) => void; | ||
| }; | ||
NullVoxPopuli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| } | ||
|
|
||
| export default class HeadlessFormControlInputComponent<VALUE> extends Component< | ||
| HeadlessFormControlInputComponentSignature<VALUE> | ||
| > { | ||
| get type(): InputType { | ||
| return this.args.type ?? 'text'; | ||
| } | ||
|
|
||
| get valueAsString(): string { | ||
| assert( | ||
| `input can only handle string values, but you passed ${typeof this.args | ||
| .value}`, | ||
| typeof this.args.value === 'string' | ||
| ); | ||
|
|
||
| return this.args.value; | ||
| } | ||
|
|
||
| @action | ||
| handleInput(e: Event | InputEvent): void { | ||
| this.args.setValue((e.target as HTMLInputElement).value as VALUE); | ||
| } | ||
| } | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,16 @@ | ||
| {{#let (unique-id) (fn @set @name) as |uuid setValue|}} | ||
|
There was a problem hiding this comment. Question: how come these There was a problem hiding this comment. Not sure what you mean here with |
||
| {{yield | ||
| (hash | ||
| label=(component (ensure-safe-component this.LabelComponent) fieldId=uuid) | ||
| input=(component | ||
| (ensure-safe-component this.InputComponent) | ||
| fieldId=uuid | ||
| value=this.value | ||
| setValue=setValue | ||
| ) | ||
| value=this.value | ||
| id=uuid | ||
| setValue=setValue | ||
| ) | ||
| }} | ||
| {{/let}} | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| import Component from '@glimmer/component'; | ||
|
|
||
| import InputComponent from './control/input'; | ||
| import LabelComponent from './field/label'; | ||
|
|
||
| import type { HeadlessFormData } from '../headless-form'; | ||
| import type { | ||
| HeadlessFormControlInputComponentSignature, | ||
| } from './control/input'; | ||
| import type { | ||
| HeadlessFormFieldLabelComponentSignature, | ||
| } from './field/label'; | ||
| import type { ComponentLike,WithBoundArgs } from '@glint/template'; | ||
|
|
||
| export interface HeadlessFormFieldComponentSignature< | ||
| DATA extends HeadlessFormData, | ||
| KEY extends keyof DATA = keyof DATA | ||
| > { | ||
| Args: { | ||
| data: DATA; | ||
| name: KEY; | ||
| set: (key: KEY, value: DATA[KEY]) => void; | ||
| }; | ||
| Blocks: { | ||
| default: [ | ||
| { | ||
| label: WithBoundArgs<typeof LabelComponent, 'fieldId'>; | ||
| input: WithBoundArgs< | ||
| typeof InputComponent<DATA[KEY]>, | ||
| 'fieldId' | 'value' | 'setValue' | ||
| >; | ||
| value: DATA[KEY]; | ||
| id: string; | ||
| setValue: (value: DATA[KEY]) => void; | ||
| } | ||
| ]; | ||
| }; | ||
| } | ||
|
|
||
| export default class HeadlessFormFieldComponent< | ||
| DATA extends HeadlessFormData, | ||
| KEY extends keyof DATA = keyof DATA | ||
| > extends Component<HeadlessFormFieldComponentSignature<DATA, KEY>> { | ||
| LabelComponent: ComponentLike<HeadlessFormFieldLabelComponentSignature> = | ||
| LabelComponent; | ||
| InputComponent: ComponentLike< | ||
| HeadlessFormControlInputComponentSignature<DATA[KEY]> | ||
| > = InputComponent; | ||
|
|
||
| get value(): DATA[KEY] { | ||
| return this.args.data[this.args.name]; | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <label for={{@fieldId}} ...attributes> | ||
| {{yield}} | ||
| </label> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,13 @@ | ||
| import templateOnlyComponent from '@ember/component/template-only'; | ||
|
|
||
| export interface HeadlessFormFieldLabelComponentSignature { | ||
| Element: HTMLLabelElement; | ||
| Args: { | ||
| fieldId: string; | ||
| }; | ||
| Blocks: { | ||
| default: []; | ||
| }; | ||
| } | ||
|
|
||
| export default templateOnlyComponent<HeadlessFormFieldLabelComponentSignature>(); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| <form ...attributes {{on 'submit' this.onSubmit}}> | ||
| {{yield | ||
| (hash | ||
| field=(component | ||
| (ensure-safe-component this.FieldComponent) | ||
| data=this.internalData | ||
| set=this.set | ||
| ) | ||
| ) | ||
| }} | ||
| </form> |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Question, just curious: We aren't supporting 3.28 anymore?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Well, this is the very start of everything, so we never supported anything before! 😆
But you are right, we are starting by not supporting Ember 3.28, at least that's the outcome of some back and forth between Preston and me. But we can revisit this decision, if you think there is a good reason to still support Ember 3.28.
Having Ember 3.28 support is good for existing addons, as that supports apps that still have trouble upgrading to 4. And it's quite unfortunate if addons don't have this overlap, and maybe only the newer version of an addon supports Ember 4, but not Ember 3.28. In this way users are forces to upgrade Ember and the addon at the same time.
But none of this applies here, as this is a green field project, and we don't have any existing Ember 3.28 users, so we can just support what is reasonable for us I think...