---
title: LineEdit
description: LineEdit api.
---

import SlintProperty from '@slint/common-files/src/components/SlintProperty.astro';
import CodeSnippetMD from '@slint/common-files/src/components/CodeSnippetMD.astro';
import Link from '@slint/common-files/src/components/Link.astro';

<CodeSnippetMD imagePath="/src/assets/generated/std-widgets-lineedit-example.png"  imageWidth="200" imageHeight="200"  imageAlt='lineedit example'>
```slint playground
import { LineEdit, VerticalBox } from "std-widgets.slint";
export component Example inherits Window {
    width: 200px;
    height: 60px;

    VerticalBox {
        LineEdit {
            placeholder-text: "Enter text here";
        }
    }
}
```
</CodeSnippetMD>

A widget used to enter a single line of text. See <Link type="TextEdit" /> for
a widget able to handle several lines of text.

## Properties

### enabled
<SlintProperty propName="enabled" typeName="bool" defaultValue="true">
When false, nothing can be entered.
</SlintProperty>

### font-size
<SlintProperty propName="font-size" typeName="length">
The size of the font of the input text
</SlintProperty>

### font-family
<SlintProperty propName="font-family" typeName="string">
The font family of the input text
</SlintProperty>

### font-italic
<SlintProperty propName="font-italic" typeName="bool" defaultValue="false">
The italic state of the font of the input text
</SlintProperty>

### has-focus
<SlintProperty propName="has-focus" typeName="bool" propertyVisibility="out">
Set to true when the line edit currently has the focus
</SlintProperty>

### horizontal-alignment
<SlintProperty propName="horizontal-alignment" typeName="enum" enumName='TextHorizontalAlignment' defaultValue="left">
The horizontal alignment of the text.
</SlintProperty>

### input-method-hints
<SlintProperty propName="input-method-hints" typeName="struct" structName="InputMethodHints">
Hints for the platform's input method (such as a soft keyboard), for example to configure auto-capitalization.
The input method may take these hints into account, but might also ignore them.
```slint "input-method-hints: { capitalization: CapitalizationMode.words };"
LineEdit {
    input-method-hints: { capitalization: CapitalizationMode.words };
}
```
</SlintProperty>

### input-type
<SlintProperty propName="input-type" typeName="enum" enumName="InputType" defaultValue="text">
The way to allow special input viewing properties such as password fields.
```slint "input-type: password;"
LineEdit {
    input-type: password;
}
```
</SlintProperty>

### placeholder-text
<SlintProperty propName="placeholder-text" typeName="string">
A placeholder text being shown when there is no text in the edit field
</SlintProperty>

### read-only
<SlintProperty propName="read-only" typeName="bool" defaultValue="false">
When set to true, text editing via keyboard and mouse is disabled but selecting text is still
enabled as well as editing text programmatically.
</SlintProperty>

### text
<SlintProperty propName="text" typeName="string" defaultValue='""' propertyVisibility="in-out">
The text being edited
```slint 'text: "Initial text";'
LineEdit {
    text: "Initial text";
}
```
</SlintProperty>

## Functions

### focus()
Call this function to focus the LineEdit and make it receive future keyboard events.

### clear-focus()
Call this function to remove keyboard focus from this `LineEdit` if it currently has the focus. See also <Link type="FocusHandling" />.

### set-selection-offsets(int, int)
Selects the text between two UTF-8 offsets.

### select-all()
Selects all text.

### clear-selection()
Clears the selection.
This function takes effect regardless of the `read-only` and `enabled` properties.

### copy()
Copies the selected text to the clipboard.

### cut()
Copies the selected text to the clipboard and removes it from the editable area.
This function takes effect regardless of the `read-only` and `enabled` properties.

### paste()
Pastes the text content of the clipboard at the cursor position.
This function takes effect regardless of the `read-only` and `enabled` properties.

## Callbacks

### accepted(string)
Invoked when the enter key is pressed.

```slint {2-4}
LineEdit {
    accepted(text) => {
        debug("Accepted: ", text);
    }
}
```

### edited(string)
Emitted when the text has changed because the user modified it

```slint {2-4}
LineEdit {
    edited(text) => {
        debug("Text edited: ", text);
    }
}
```

### key-pressed(KeyEvent) -> EventResult
Invoked when a key is pressed, the argument is a <Link type="KeyEvent" /> struct. Use this callback to
handle keys before `LineEdit` does. Return `accept` to indicate that you've handled the event, or return
`reject` to let `LineEdit` handle it.

### key-released(KeyEvent) -> EventResult
Invoked when a key is released, the argument is a <Link type="KeyEvent" /> struct. Use this callback to
handle keys before `LineEdit` does. Return `accept` to indicate that you've handled the event, or return
`reject` to let `LineEdit` handle it.
