Class: Charming::Component

Inherits:

View

• Object
• View
• Charming::Component

Defined in:

lib/charming/presentation/component.rb

Overview

Component is the base class for all reusable terminal widgets. It inherits from View to gain assigns, helper methods (text, box, row, column, etc.), and rendering via render.

Direct Known Subclasses

Charming::Components::ActivityIndicator, Charming::Components::Audio, Charming::Components::Autocomplete, Charming::Components::Badge, Charming::Components::Breadcrumbs, Charming::Components::CommandPalette, Charming::Components::CommandPaletteModal, Charming::Components::EmptyState, Charming::Components::ErrorScreen, Charming::Components::Form, Charming::Components::Form::Field, Charming::Components::HelpOverlay, Charming::Components::List, Charming::Components::Markdown, Charming::Components::Modal, Charming::Components::Progressbar, Charming::Components::Spinner, Charming::Components::StatusBar, Charming::Components::TabBar, Charming::Components::Table, Charming::Components::TextArea, Charming::Components::TextInput, Charming::Components::Toast, Charming::Components::Tree, Charming::Components::Viewport

Instance Method Summary

• #captures_text? ⇒ Boolean

  True for components that accept free-typed text (TextInput, TextArea, Form, …).

Methods inherited from View

#focused?, #initialize, #layout_assigns, #render

Constructor Details

This class inherits a constructor from Charming::View

Instance Method Details

#captures_text? ⇒ Boolean

True for components that accept free-typed text (TextInput, TextArea, Form, …). While such a component is focused, the controller routes printable characters to it BEFORE global/content key bindings — so typing “q” or “?” into a field inserts the character instead of triggering an app shortcut.

Returns:

• (Boolean)

# File 'lib/charming/presentation/component.rb', line 11

def captures_text?
  false
end