ComponentsControls

SettingsButton

A control component that opens the video player's settings menu

Usage


Props

PropTypeRequiredDefaultDescription
sizenumberNo–Size of the icon.
colorstringNo–Color of the icon.
styleStyleProp<ViewStyle>No–Optional styles for the button container.
renderSettingIcon() => React.ReactNodeNoGear icon (Settings)Custom render function for the settings icon.

Examples

Default Settings Button

import { SettingsButton } from 'react-native-video-toolkit';

<SettingsButton size={28} color="#fff" />;

Custom Icon

import { SettingsButton } from 'react-native-video-toolkit';
import { Sliders } from 'lucide-react';
import React from 'react';

<SettingsButton renderSettingIcon={() => <Sliders />} />;

  • Works seamlessly inside control bars alongside PlayButton, MuteButton, and FullscreenButton.
  • Typically used to open menus for:
    • Video quality selection
    • Subtitle / text track management
    • Playback speed adjustment

On this page