A pack of extensions for grommet 2
created:4/30/2021
updated:4/30/2021
loc
7
comments
57%
failed
2
coverage
100%

EmailInput

avatar of atanasster
grommet-controls
3.0.1

A masked input with a default mask for handling email addresses. All properties of MaskedInput apply.

import { EmailInput } from 'grommet-controls';

Main

Name
Description
Default
IDropInputOwnProps(14 properties)
defaultValue

default value for uncontrolled mode

string | number | (string & readonly string[]) | (number & readonly string[])
-
onChange

Function that will be called when the user enters a new value

((x: { target: HTMLInputElement; }) => void) & ((event: ChangeEvent<HTMLInputElement>) => void)
-
onKeyDown

Callback for when a key is pressed

((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) & ((event: KeyboardEvent<HTMLInputElement>) => void)
-
onKeyUp

Callback for when a key is released

((event: MouseEvent<HTMLButtonElement, MouseEvent>) => void) & ((event: KeyboardEvent<HTMLInputElement>) => void)
-
a11yTitle

Custom title to be used by screen readers

string
-
a11yDropTitle

Custom drop button title to be used by screen readers

string
-
dropAlign
{ top?: "top" | "bottom"; bottom?: "top" | "bottom"; right?: "left" | "right"; left?: "left" | "right"; } & { top?: "top" | "bottom"; bottom?: "top" | "bottom"; right?: "left" | "right"; left?: "left" | "right"; }
-
dropTarget

Target where the drop will be aligned to. This should be a React reference. Typically, this is not required as the drop will be aligned to the DropButton itself by default

object
-
dropContent

Content to put inside the Drop

Element
-
dropIcon

Icon for drop content

Element
-
widgets

Additional widgets to be placed next to the input

{ [x: string]: any; icon: Element; }[]
-
onOpen

Callback for when the drop is opened

(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
onClose

Callback for when the drop is closed

(event: MouseEvent<HTMLButtonElement, MouseEvent>) => void
-
update

functio n to be called on update

(fn: (value: string) => void) => void
-
TextInputProps(19 properties)
Attributes(1 properties)
InputHTMLAttributes(28 properties)
HTMLAttributes(40 properties)
AriaAttributes(48 properties)
DOMAttributes(157 properties)
IMaskedInputOwnProps(6 properties)

Commits

Date
Author
Commit Message
8/31/2020

atanasster

avatar of atanasster
update stories titles and navigation
8/30/2020

atanasster

avatar of atanasster
update eslint and add component-controls
8/27/2019

atanasster

avatar of atanasster
initial commit 2.x alpha
3 commits
package
imports
peer
react
^17.0.1
React
*
file
imports
"../MaskedInput"
MaskedInput
"./EmailInputProps"
IEmailInputProps