	Language
	English
	English
	English
	French
	German
	German
	German
	Italian
	Korean
	Spanish
	Catalan
	Dutch
	Portuguese
	Portuguese
	Arabic
	Arabic
	Bulgarian
	Bangla
	Bosnian
	Czech
	Greek
	Estonian
	Persian
	Finnish
	Danish
	Hindi
	Indonesian
	Icelandic
	Croatian
	Japanese
	Hungarian
	Hebrew
	Georgian
	Central Kurdish
	Khmer
	Kyrgyz
	Kazakh
	Lithuanian
	Latvian
	Malay
	Norwegian
	Polish
	Romanian
	Russian
	Slovak
	Slovenian
	Serbian
	Serbian
	Swedish
	Thai
	Turkish
	Ukrainian
	Uzbek
	Vietnamese
	Chinese
	Chinese

Keyboard

A virtual keyboard for text input.

Keyboard Tag Documentation

Keyboard is an input component that uses a virtual keyboard to provide the input.

Name	Type	Required	Default	Description
id	String	false	generated	Unique identifier of the component in a namingContainer.
rendered	boolean	false	true	Boolean value to specify the rendering of the component, when set to false component will not be rendered.
binding	UIComponent	false	generated	An EL expression referring to a server side UIComponent instance in a backing bean.
widgetVar	String	false	generated ('widget_' + componentClientId)	Name of the client side component.
accesskey	String	false		Access key to transfer focus to the input element.
alt	String	false		Alternate textual description of the input field.
ariaDescribedBy	String	false		Identifies the element(s) that describe the object, enhancing accessibility.
autocomplete	String	false		Controls browser autocomplete behavior. Possible values are 'on', 'off', and 'new-password'.
backspaceLabel	String	false		Label for backspace button.
buttonImage	String	false		Image URL for the keyboard toggle button.
buttonImageOnly	boolean	false	false	When enabled, shows only the button image without text.
clearLabel	String	false		Label for clear button.
closeLabel	String	false		Label for close button.
converter	Converter	false		EL expression resolves to a converter instance or literal converter ID defining a component converter.
converterMessage	String	false		Custom message to display when conversion fails.
dir	String	false	ltr	Direction indication for text that does not inherit directionality.
disabled	boolean	false	false	Specifies that an element should be disabled.
effect	String	false	fadeIn	Animation effect when showing/hiding keyboard.
effectDuration	String	false		Duration of the animation effect.
immediate	boolean	false	false	When set true, process validations logic is executed at apply request values phase for this component.
inputmode	String	false		Specifies the type of data expected in the input, aiding virtual keyboards.
keypadOnly	boolean	false	false	When enabled, shows only numeric keypad.
label	String	false		A localized user presentable name.
lang	String	false		Specifies the language of the element's content.
layout	String	false	qwerty	Keyboard layout. Options: 'qwerty', 'alpha', 'international', 'custom'.
layoutTemplate	String	false		Custom layout template for keyboard.
localValueSet	boolean	false	false	Indicates whether the local value of the component has been set.
maxlength	int	false	Integer.MIN_VALUE	Defines the maximum number of characters allowed in the input.
onblur	String	false		Fires when an element loses focus.
onchange	String	false		Fires when the value of an element has been changed.
onclick	String	false		Fires when a mouse click on the element.
oncontextmenu	String	false		Script to execute when the context menu is triggered.
oncopy	String	false		Script to execute when content is copied from the element.
oncut	String	false		Script to execute when content is cut from the element.
ondblclick	String	false		Fires when a mouse double-click on the element.
ondrag	String	false		Script to execute when an element is dragged.
ondragend	String	false		Script to execute at the end of a drag operation.
ondragenter	String	false		Script to execute when a dragged element enters a valid drop target.
ondragleave	String	false		Script to execute when a dragged element leaves a valid drop target.
ondragover	String	false		Script to execute when a dragged element is over a valid drop target.
ondragstart	String	false		Script to execute at the start of a drag operation.
ondrop	String	false		Script to execute when a dragged element is dropped.
onfocus	String	false		Fires when an element gets focus.
oninput	String	false		Script to execute when the element receives user input.
oninvalid	String	false		Script to execute when the element's value is invalid.
onkeydown	String	false		Fires when a user is pressing a key.
onkeypress	String	false		Fires when a user presses a key.
onkeyup	String	false		Fires when a user releases a key.
onmousedown	String	false		Fires when a mouse button is pressed down on an element.
onmousemove	String	false		Fires when the mouse pointer is moving while it is over an element.
onmouseout	String	false		Fires when the mouse pointer moves out of an element.
onmouseover	String	false		Fires when the mouse pointer moves onto an element.
onmouseup	String	false		Fires when a mouse button is released over an element.
onpaste	String	false		Script to execute when content is pasted into the element.
onreset	String	false		Script to execute when the form is reset.
onscroll	String	false		Script to execute when the element is scrolled.
onsearch	String	false		Script to execute when a search is performed.
onselect	String	false		Script to execute when text is selected.
onwheel	String	false		Script to execute when the mouse wheel is used.
password	boolean	false	false	When enabled, masks input as password.
placeholder	String	false		Specifies a short hint describing the expected value of the input.
promptLabel	String	false		Label for prompt button.
readonly	boolean	false	false	Specifies that an input field is read-only.
required	boolean	false	false	Marks component as required.
requiredMessage	String	false		Custom message to display when the required validation fails.
role	String	false		Defines the role of the element for accessibility purposes.
showMode	String	false	focus	Mode to show the keyboard. Options: 'focus', 'click', 'button'.
size	int	false	Integer.MIN_VALUE	Number of characters used to determine the width of the input element.
style	String	false		Specifies an inline CSS style for an element.
styleClass	String	false		Specifies one or more CSS class names for an element.
submittedValue	Object	false
tabindex	String	false		Specifies the tab order of an element.
title	String	false		Specifies extra information about an element (displayed as a tooltip).
type	String	false	text	Input field type.
valid	boolean	false	true	Indicates whether the input's value is valid.
validator	Validator	false		A method expression referring to a method validating the input.
validatorMessage	String	false		Custom message to display when validation fails.
value	Object	false		Value of the component.
valueChangeListener	ValueChangeListener	false		A method binding expression referring to a method for handling a valuchangeevent.

Name	Description
No records found.

Name	Type	Default	Description
blur	AjaxBehaviorEvent	false	Fires when the element loses focus.
change	AjaxBehaviorEvent	false	Fires when the element's value changes.
click	AjaxBehaviorEvent	false	Fires when the element is clicked.
contextmenu	AjaxBehaviorEvent	false	Fires when the context menu is triggered on the element.
copy	AjaxBehaviorEvent	false	Fires when a copy operation occurs on the element.
cut	AjaxBehaviorEvent	false	Fires when a cut operation occurs on the element.
dblclick	AjaxBehaviorEvent	false	Fires when the element is double-clicked.
drag	AjaxBehaviorEvent	false	Fires when an element or text selection is being dragged.
dragend	AjaxBehaviorEvent	false	Fires when a drag operation is being ended.
dragenter	AjaxBehaviorEvent	false	Fires when a dragged element enters a valid drop target.
dragleave	AjaxBehaviorEvent	false	Fires when a dragged element leaves a valid drop target.
dragover	AjaxBehaviorEvent	false	Fires when a dragged element is over a valid drop target.
dragstart	AjaxBehaviorEvent	false	Fires when the user starts dragging an element.
drop	AjaxBehaviorEvent	false	Fires when an element is dropped on a valid drop target.
focus	AjaxBehaviorEvent	false	Fires when the element gains focus.
input	AjaxBehaviorEvent	false	Fires when the value of an input element is changed.
invalid	AjaxBehaviorEvent	false	Fires when the element is invalid.
keydown	AjaxBehaviorEvent	false	Fires when a key is pressed down on the element.
keypress	AjaxBehaviorEvent	false	Fires when a key is pressed and released on the element.
keyup	AjaxBehaviorEvent	false	Fires when a key is released on the element.
mousedown	AjaxBehaviorEvent	false	Fires when a mouse button is pressed down on the element.
mousemove	AjaxBehaviorEvent	false	Fires when the mouse is moved over the element.
mouseout	AjaxBehaviorEvent	false	Fires when the mouse leaves the element.
mouseover	AjaxBehaviorEvent	false	Fires when the mouse enters the element.
mouseup	AjaxBehaviorEvent	false	Fires when a mouse button is released over the element.
paste	AjaxBehaviorEvent	false	Fires when a paste operation occurs on the element.
reset	AjaxBehaviorEvent	false	Fires when the form is reset.
scroll	AjaxBehaviorEvent	false	Fires when the element is scrolled.
search	AjaxBehaviorEvent	false	Fires when a search is initiated on the element.
select	AjaxBehaviorEvent	false	Fires when some text is selected in the element.
valueChange	AjaxBehaviorEvent	true	Fires when the element's value is changed.
wheel	AjaxBehaviorEvent	false	Fires when the wheel event is triggered on the element.

Name	Library	Target
components.css	primefaces
keyboard/keyboard.css	primefaces
jquery/jquery.js	primefaces
core.js	primefaces
components.js	primefaces
keyboard/keyboard.js	primefaces

Family org.primefaces.component

Type org.primefaces.component.Keyboard

Class org.primefaces.component.keyboard.Keyboard

Renderer Type org.primefaces.component.KeyboardRenderer

Renderer Class org.primefaces.component.keyboard.KeyboardRenderer

RESOURCES

Tag Documentation Documentation Documentation JSDoc


<div class="card">
    <h:form>
        <div class="p-fluid formgrid grid">
            <div class="field col-12 md:col-4">
                <p:outputLabel for="default" value="Default Layout: "/>
                <p:keyboard id="default" value="#{keyboardView.value1}"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="qwerty" value="Basic QWERTY: "/>
                <p:keyboard id="qwerty" value="#{keyboardView.value2}" layout="qwertyBasic"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="alphabetic" value="Alphabetic Layout: "/>
                <p:keyboard id="alphabetic" value="#{keyboardView.value3}" layout="alphabetic"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="custom1" value="Custom Layout 1: "/>
                <p:keyboard id="custom1" value="#{keyboardView.value4}" layout="custom"
                            layoutTemplate="prime-back,faces-clear,rocks-close"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="custom2" value="Custom Layout 2: "/>
                <p:keyboard id="custom2" value="#{keyboardView.value5}" layout="custom"
                            layoutTemplate="create-space-your-close,owntemplate-shift,easily-space-spacebar"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="keypad" value="Default Keypad: "/>
                <p:keyboard id="keypad" value="#{keyboardView.value6}" keypadOnly="true"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="password" value="Password Mode: "/>
                <p:keyboard id="password" value="#{keyboardView.value9}" password="true" keypadOnly="true"/>
            </div>

            <div class="field col-12 md:col-4">
                <p:outputLabel for="rtl" value="RTL: "/>
                <p:keyboard id="rtl" value="#{keyboardView.value1}" dir="rtl"/>
            </div>
        </div>
    </h:form>
</div>


package org.primefaces.showcase.view.input;

import jakarta.enterprise.context.RequestScoped;
import jakarta.inject.Named;

@Named
@RequestScoped
public class KeyboardView {

    private String value1;
    private String value2;
    private String value3;
    private String value4;
    private String value5;
    private String value6;
    private String value7;
    private String value8;
    private String value9;

    public String getValue1() {
        return value1;
    }

    public void setValue1(String value1) {
        this.value1 = value1;
    }

    public String getValue2() {
        return value2;
    }

    public void setValue2(String value2) {
        this.value2 = value2;
    }

    public String getValue3() {
        return value3;
    }

    public void setValue3(String value3) {
        this.value3 = value3;
    }

    public String getValue4() {
        return value4;
    }

    public void setValue4(String value4) {
        this.value4 = value4;
    }

    public String getValue5() {
        return value5;
    }

    public void setValue5(String value5) {
        this.value5 = value5;
    }

    public String getValue6() {
        return value6;
    }

    public void setValue6(String value6) {
        this.value6 = value6;
    }

    public String getValue7() {
        return value7;
    }

    public void setValue7(String value7) {
        this.value7 = value7;
    }

    public String getValue8() {
        return value8;
    }

    public void setValue8(String value8) {
        this.value8 = value8;
    }

    public String getValue9() {
        return value9;
    }

    public void setValue9(String value9) {
        this.value9 = value9;
    }

}

Keyboard

Keyboard Tag Documentation

Usage

Reloading page