Extract and set form values through the DOM—no frameworks required! https://github.com/TheoryOfNekomata/formxtra
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
TheoryOfNekomata 8511d76949 Update README 1 年之前
cypress Cover all input types 1 年之前
docs Update README 1 年之前
src Update documentation 1 年之前
.eslintrc Switch to pridepack, add setFormValues 1 年之前
.gitignore Add coverage reporting 1 年之前
.npmignore Add coverage reporting 1 年之前
.prettierrc Separate prettierrc 3 年之前
LICENSE Switch to pridepack, add setFormValues 1 年之前
README.md Update README 1 年之前
cypress.json Add support for multiple values 1 年之前
package.json Update tests, fix multiple value setting 1 年之前
pridepack.json Switch to pridepack, add setFormValues 1 年之前
publish.sh Update usage notes, prepare for publishing 3 年之前
test-globals.js Switch to pridepack, add setFormValues 1 年之前
tsconfig.eslint.json Update tsconfig 1 年之前
tsconfig.json Update tsconfig 1 年之前
vitest.config.js Switch to pridepack, add setFormValues 1 年之前
yarn.lock Add coverage reporting 1 年之前

README.md

formxtra

The companion for Web forms!

Extract and set form values through the DOM—no frameworks required!

Lightweight. Simple. It Just Works.

Installation

The package can be found on:

Usage

For an example form:

<button id="autofill" type="button">
  Autofill login form
</button>

<form id="loginForm">
  <input type="text" name="username" />
  <input type="password" name="password" />
  <button type="submit" name="type" value="client">
    Log In As Client
  </button>
  <button type="submit" name="type" value="admin">
    Log In As Admin
  </button>
</form>

<label>
  <input type="checkbox" name="remember" form="loginForm" />
  Remember my login credentials
</label>

Use the library as follows (code is in TypeScript, but can work with JavaScript as well):

import { getFormValues, setFormValues } from '@theoryofnekomata/formxtra';

// This is the only query we need. On libraries like React, we can easily get form elements when we
// attach submit event listeners.
const form: HTMLFormElement = document.getElementById('form');

const processResponse = async (response: Response) => {
  const result = await response.json();

  alert(`Welcome ${result.user}!`);
};

// Best use case is with event handlers
form.addEventListener('submit', async e => {
  const {
    currentTarget: thisForm,
    submitter,
  } = e;
  e.preventDefault();

  const values = getFormValues(thisForm, { submitter });

  // Get the form values and send as request to some API
  const response = await fetch(
    'https://example.com/api/log-in',
    {
      method: 'POST',
      body: JSON.stringify(values),
      headers: {
        'Content-Type': 'application/json',
      },
    },
  );

  if (response.ok) {
    processResponse(response);
  }
});

const autofillButton = document.getElementById('autofill');

autofillButton.addEventListener('click', e => {
  setFormValues(form, { username: 'admin', remember: true });
});

There are utility functions exported alongside getFormValues() and setFormValues(). You may want to use namespace import with this library, i.e. import * as formxtra from '@theoryofnekomata/formxtra'.

See the documentation folder for more details.

Tests

The library has been tested on the static DOM using JSDOM, and the real dynamic DOM using Cypress.

License

MIT