SecureField

A SwiftUI SecureField component for password input.

iOS

tvOS

GitHub

npm

Changelog

Bundled version:

~55.0.10

Expo UI SecureField matches the official SwiftUI SecureField API and provides a text field that masks user input for passwords and other sensitive text.

Installation

Terminal

- npx expo install @expo/ui

If you are installing this in an existing React Native app, make sure to install expo in your project.

Usage

Basic secure field

BasicSecureFieldExample.tsx

import { useState } from 'react';
import { Host, SecureField } from '@expo/ui/swift-ui';

export default function BasicSecureFieldExample() {
  const [password, setPassword] = useState('');

  return (
    <Host matchContents>
      <SecureField placeholder="Password" onValueChange={setPassword} />
    </Host>
  );
}

Submit handling

Use the submitLabel and onSubmit modifiers to handle form submission from the keyboard.

SecureFieldSubmitExample.tsx

import { useState } from 'react';
import { Host, SecureField } from '@expo/ui/swift-ui';
import { submitLabel, onSubmit } from '@expo/ui/swift-ui/modifiers';

export default function SecureFieldSubmitExample() {
  const [password, setPassword] = useState('');

  return (
    <Host matchContents>
      <SecureField
        placeholder="Password"
        onValueChange={setPassword}
        modifiers={[submitLabel('done'), onSubmit(() => console.log('Login submitted'))]}
      />
    </Host>
  );
}

Imperative ref

Use a ref to imperatively set text, focus, or blur the secure field.

ImperativeSecureFieldExample.tsx

import { useRef } from 'react';
import { Host, SecureField, SecureFieldRef, Button, HStack, VStack } from '@expo/ui/swift-ui';
import { buttonStyle } from '@expo/ui/swift-ui/modifiers';

export default function ImperativeSecureFieldExample() {
  const ref = useRef<SecureFieldRef>(null);

  return (
    <Host matchContents>
      <VStack>
        <SecureField ref={ref} placeholder="Password" />
        <HStack spacing={12}>
          <Button
            modifiers={[buttonStyle('bordered')]}
            onPress={() => ref.current?.focus()}
            label="Focus"
          />
          <Button
            modifiers={[buttonStyle('bordered')]}
            onPress={() => ref.current?.blur()}
            label="Blur"
          />
          <Button
            modifiers={[buttonStyle('bordered')]}
            onPress={() => ref.current?.setText('secret123')}
            label="Set Text"
          />
        </HStack>
      </VStack>
    </Host>
  );
}

API

import { SecureField } from '@expo/ui/swift-ui';

Component

`SecureField`

iOS

tvOS

Type: React.Element<SecureFieldProps>

Renders a SwiftUI SecureField for password input.

SecureFieldProps

`autoFocus`

iOS

tvOS

Optional • Type: boolean • Default: false

If true, the field will be focused automatically when mounted.

`defaultValue`

iOS

tvOS

Optional • Type: string

Initial value displayed when mounted. Uncontrolled — change key to reset.

`onFocusChange`

iOS

tvOS

Optional • Type: (focused: boolean) => void

A callback triggered when the field gains or loses focus.

`onValueChange`

iOS

tvOS

Optional • Type: (value: string) => void

A callback triggered when the text value changes.

`placeholder`

iOS

tvOS

Optional • Type: string

A text that is displayed when the field is empty.

`ref`

iOS

tvOS

Optional • Type: Ref<SecureFieldRef>

Inherited Props

CommonViewModifierProps

Types

`SecureFieldRef`

iOS

tvOS

Can be used for imperatively setting text and focus on the SecureField component.

Property	Type	Description
blur	`() => Promise<void>`	-
focus	`() => Promise<void>`	-
setText	`(newText: string) => Promise<void>`	-