Struct QrCodeWidget 

pub struct QrCodeWidget { /* private fields */ }

A Ratatui widget that renders a QR code.

This widget can be used to render a QR code in a terminal. It uses the qrcode crate to generate the QR code.

Examples

use qrcode::QrCode;
use tui_qrcode::QrCodeWidget;

let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
let widget = QrCodeWidget::new(qr_code);

The widget can be customized using the quiet_zone, scaling, colors, and style methods. Additionally, the widget implements the Styled trait, so all the methods from Ratatui’s ratatui_core::style::Stylize trait can be used.

use qrcode::QrCode;
use ratatui::style::{Style, Stylize};
use ratatui::Frame;
use tui_qrcode::{Colors, QrCodeWidget, QuietZone, Scaling};

fn render(frame: &mut Frame) {
    let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
    let widget = QrCodeWidget::new(qr_code)
        .quiet_zone(QuietZone::Disabled)
        .scaling(Scaling::Max)
        .colors(Colors::Inverted)
        .red()
        .on_light_yellow();
    frame.render_widget(widget, frame.area());
}

Implementations

impl QrCodeWidget

pub fn new(qr_code: QrCode) -> QrCodeWidget

Create a new QR code widget.

pub const fn quiet_zone(self, quiet_zone: QuietZone) -> QrCodeWidget

Set whether the QR code should have a quiet zone.

This is the white border around the QR code. By default, the quiet zone is enabled.

Example

use qrcode::QrCode;
use tui_qrcode::{QrCodeWidget, QuietZone};

let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
let widget = QrCodeWidget::new(qr_code).quiet_zone(QuietZone::Disabled);

pub const fn scaling(self, scaling: Scaling) -> QrCodeWidget

Set how the QR code should be scaled.

By default, the QR code will be scaled so each pixel is 1x1.

The Min variant will scale the QR code so it is at least the size of the widget. This may result in a QR code that is larger than the widget, which is not ideal. The Max variant will scale the QR code so it is at most the size of the widget. This may result in a QR code which is scaled more horizontally or vertically than the other, which may not be ideal. The Exact variant will scale the QR code so each pixel is the size of the given dimensions. The minimum scaling is 1x1 (width x height).

Example

use qrcode::QrCode;
use tui_qrcode::{QrCodeWidget, Scaling};

let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
let widget = QrCodeWidget::new(qr_code).scaling(Scaling::Max);

pub const fn colors(self, colors: Colors) -> QrCodeWidget

Set the colors of the QR code.

By default, the colors are normal (light on dark).

The Normal variant will use the default colors. The Inverted variant will invert the colors (dark on light).

To set the foreground and background colors of the widget, use the style method.

Example

use qrcode::QrCode;
use tui_qrcode::{Colors, QrCodeWidget};

let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
let widget = QrCodeWidget::new(qr_code).colors(Colors::Inverted);

pub fn style(self, style: impl Into<Style>) -> QrCodeWidget

Set the style of the widget.

This will set the foreground and background colors of the widget.

Example

use qrcode::QrCode;
use ratatui::style::{Style, Stylize};
use tui_qrcode::QrCodeWidget;

let qr_code = QrCode::new("https://ratatui.rs").expect("failed to create QR code");
let style = Style::new().red().on_light_yellow();
let widget = QrCodeWidget::new(qr_code).style(style);

pub fn size(&self, area: Rect) -> Size

The theoretical size of the QR code if rendered into area.

Note that if the QR code does not fit into area, the resulting Size might be larger than the size of area.

Example

use qrcode::QrCode;
use ratatui::layout::Rect;
use tui_qrcode::{QrCodeWidget, Scaling};

let qr_code = QrCode::new("https://ratatui.rs")?;
let widget = QrCodeWidget::new(qr_code).scaling(Scaling::Min);
let area = Rect::new(0, 0, 50, 50);
let widget_size = widget.size(area);

assert_eq!(widget_size.width, 66);
assert_eq!(widget_size.height, 66);

Trait Implementations

impl Styled for QrCodeWidget

type Item = QrCodeWidget

fn style(&self) -> Style

Returns the style of the object.

fn set_style<S>(self, style: S) -> <QrCodeWidget as Styled>::Item

where S: Into<Style>,

Sets the style of the object.

impl Widget for &QrCodeWidget

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.

impl Widget for QrCodeWidget

fn render(self, area: Rect, buf: &mut Buffer)

Draws the current state of the widget in the given buffer. That is the only method required to implement a custom widget.