@justeat/f-form-field

f-form-field

Fozzie Form Field Component.

---

---

Usage

Installation

Install the module using npm or Yarn:

yarn add @justeat/f-form-field

npm install @justeat/f-form-field

Vue Applications

You can import it in your Vue SFC like this (please note that styles have to be imported separately):

import FormField from '@justeat/f-form-field';
import '@justeat/f-form-field/dist/f-form-field.css';

export default {
    components: {
        FormField
    }
}

If you are using Webpack, you can import the component dynamically to separate the f-form-field bundle from the main bundle.client.js:

import '@justeat/f-form-field/dist/f-form-field.css';

export default {
    components: {
        // …
        FormField: () => import(/* webpackChunkName: "form-field" */ '@justeat/f-form-field')
    }
}

Configuration

Props

There may be props that allow you to customise its functionality.

The props that can be defined are as follows (if any):

Prop	Type	Default	Description
locale	String	''	Sets locale for I18n.
labelText	String	''	The text that will be displayed in the form field label.
inputType	String	text	The type of input needed. Options: text, email, password, radio, checkbox, dropdown, number, tel, textarea
labelStyle	String	'default'	Defines where the label will be rendered in relation to the form field. Options: default - Displays the label above the form field, inline Displays the label inside the form field, inlineNarrow Displays the label above the form field when in web/tablet. Displays the label inside the form field when in mobile.
value	String or Number	''	The value of the form field.
hasError	Boolean	false	When true border colour changes to red.
dropdownOptions	Array	null	The options to be displayed in the dropdown.
isGrouped	Boolean	false	When true will remove margin between all grouped form fields.
minNumber	Number or undefined	undefined	Sets the value of the min property when inputType is number
maxNumber	Number or undefined	undefined	Sets the value of the max property when inputType is number
hasInputDescription	Boolean	false	When true will add the ability to insert extra html element under form label to the component via slot.

Events

The events that can be subscribed to are as follows (if any):

Event	Description
input	Fired when a user changes the value of the form field, args contain details of the change and its context.

Development

Start by cloning the repository and installing the required dependencies:

$ git clone [e-mail]:justeat/fozzie-components.git
$ cd fozzie-components
$ yarn

Change directory to the f-form-field package:

$ cd packages/components/molecules/f-form-field

Testing

Unit, Integration and Contract

To test all components, run from root directory. To test only f-form-field, run from the ./fozzie-components/packages/f-form-field directory.

yarn test

Component Tests

# Run Component tests for all components
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components

yarn storybook:build
yarn storybook:serve-static
yarn test-component:chrome

OR

# Run Component tests for f-form-field
# Note: Ensure Storybook is not running when running the following commands
cd ./fozzie-components/packages/f-form-field
yarn test-component:chrome

Documentation to be completed once module is in stable state.

Changelog

v1.16.0

June 8, 2020

Changed

• Updated fozzie and fozzie-colour-palette dependencies to pull in updated JET theme variables for ML.