diff --git a/docs/getting-started/form-controls.md b/docs/getting-started/form-controls.md index 0a610458a..3573c545c 100644 --- a/docs/getting-started/form-controls.md +++ b/docs/getting-started/form-controls.md @@ -6,8 +6,6 @@ Shoelace solves this problem by using the [`formdata`](https://developer.mozilla ?> Shoelace uses event listeners to intercept the form's `formdata` and `submit` events. This allows it to inject data and trigger validation as necessary. If you're also attaching an event listener to the form, _you must attach it after Shoelace form controls are connected to the DOM_, otherwise your logic will run before Shoelace has a chance to inject form data and validate form controls. -?> If you're using an older browser that doesn't support the `formdata` event, a lightweight polyfill will be automatically applied to ensure forms submit as expected. - ## Data Serialization Serialization is just a fancy word for collecting form data. If you're relying on standard form submissions, e.g. `
`, you can probably skip this section. However, most modern apps use the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API) or a library such as [axios](https://github.com/axios/axios) to submit forms using JavaScript. diff --git a/docs/resources/changelog.md b/docs/resources/changelog.md index a2d3ea5d5..1e1b887b7 100644 --- a/docs/resources/changelog.md +++ b/docs/resources/changelog.md @@ -16,6 +16,7 @@ New versions of Shoelace are released as-needed and generally occur when a criti - Fixed a bug in `` that caused the `sl-change` event to be incorrectly emitted when the value was set programmatically [#917](https://github.com/shoelace-style/shoelace/issues/917) - Fixed a bug in `` and `` that made it impossible to disable spell checking [#1061](https://github.com/shoelace-style/shoelace/issues/1061) - Fixed non-modal behaviors in `` when using the `contained` attribute [#1051](https://github.com/shoelace-style/shoelace/issues/1051) +- Removed the `formdata` event polyfill since it's now available in the last two versions of all major browsers ## 2.0.0-beta.86 diff --git a/src/internal/form.ts b/src/internal/form.ts index 7b977fc17..a1ea09c37 100644 --- a/src/internal/form.ts +++ b/src/internal/form.ts @@ -1,4 +1,3 @@ -import './formdata-event-polyfill'; import type SlButton from '../components/button/button'; import type { ShoelaceFormControl } from '../internal/shoelace-element'; import type { ReactiveController, ReactiveControllerHost } from 'lit'; diff --git a/src/internal/formdata-event-polyfill.ts b/src/internal/formdata-event-polyfill.ts deleted file mode 100644 index ce3fa19e8..000000000 --- a/src/internal/formdata-event-polyfill.ts +++ /dev/null @@ -1,107 +0,0 @@ -/* eslint-disable */ -// @ts-nocheck -// -// Polyfills the formdata event in unsupportive browsers. This is a partial polyfill to support appending custom element -// form data on submit. The formdata event landed in Safari until 15.1, which is slighly too new to rely on. All other -// browsers have great support. -// -// https://caniuse.com/mdn-api_htmlformelement_formdata_event -// -// Original code derived from: https://gist.github.com/WickyNilliams/eb6a44075356ee504dd9491c5a3ab0be -// -// Copyright (c) 2021 Nick Williams (https://wicky.nillia.ms) -// -// Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: -// The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. -// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. -// -class FormDataEventPolyfill extends Event { - formData: FormData; - - constructor(formData: FormData) { - super('formdata'); - this.formData = formData; - } -} - -class FormDataPolyfill extends FormData { - private form: HTMLFormElement; - - constructor(form?: HTMLFormElement | null) { - if (form) { - super(form); - this.form = form; - form.dispatchEvent(new FormDataEventPolyfill(this)); - } else { - super(); - } - } - - append(name: string, value: any) { - if (!this.form) { - return super.append(name, value); - } - - let input = this.form.elements[name as any] as HTMLInputElement; - - if (!input) { - input = document.createElement('input'); - input.type = 'hidden'; - input.name = name; - this.form.appendChild(input); - } - - if (this.has(name)) { - const entries = this.getAll(name); - const index = entries.indexOf(input.value); - - if (index !== -1) { - entries.splice(index, 1); - } - - entries.push(value); - this.set(name, entries as any); - } else { - super.append(name, value); - } - - input.value = value; - } -} - -function supportsFormDataEvent() { - const form = document.createElement('form'); - let isSupported = false; - - document.body.append(form); - - form.addEventListener('submit', event => { - new FormData(event.target as HTMLFormElement); - event.preventDefault(); - }); - - form.addEventListener('formdata', () => (isSupported = true)); - form.dispatchEvent(new Event('submit', { cancelable: true })); - form.remove(); - - return isSupported; -} - -function polyfillFormData() { - if (!window.FormData || supportsFormDataEvent()) { - return; - } - - window.FormData = FormDataPolyfill; - window.addEventListener('submit', event => { - if (!event.defaultPrevented) { - new FormData(event.target as HTMLFormElement); - } - }); -} - -if (document.readyState === 'complete') { - polyfillFormData(); -} else { - window.addEventListener('DOMContentLoaded', () => polyfillFormData()); -}