Crate bevy_cosmic_edit

bevy_cosmic_edit

Multiline text editor using cosmic_text for the bevy game engine!

This bevy plugin provides multiline text editing for bevy apps, thanks to cosmic_text crate! Emoji, ligatures, and other fancy stuff is supported!

Usage

 Warning: This plugin is currently in early development, and its API is subject to change.

use bevy::prelude::*;
use bevy_cosmic_edit::*;

fn setup(mut commands: Commands, mut font_system: ResMut<CosmicFontSystem>) {
    commands.spawn(Camera2dBundle::default());

    // Text attributes
    let font_size = 16.0;
    let line_height = 18.0;
    let attrs = Attrs::new()
        .family(Family::Monospace)
        .color(Color::DARK_GRAY.to_cosmic())
        .weight(FontWeight::BOLD);

    // Spawning
    commands.spawn(CosmicEditBundle {
        buffer: CosmicBuffer::new(&mut font_system, Metrics::new(font_size, line_height))
            .with_text(&mut font_system, "Hello, Cosmic!", attrs),
        sprite_bundle: SpriteBundle {
            sprite: Sprite {
                custom_size: Some(Vec2::new(300.0, 40.0)),
                ..default()
            },
            ..default()
        },
        ..default()
    });
}

fn main() {
    App::new()
        .add_plugins(DefaultPlugins)
        .add_plugins(CosmicEditPlugin::default())
        .add_systems(Startup, setup)
        .add_systems(Update, change_active_editor_sprite)
        .run();
}

Check the examples folder for much more!

Native:

$ cargo r --example font_per_widget

Wasm:

$ cargo install wasm-server-runner
$ RUSTFLAGS=--cfg=web_sys_unstable_apis cargo r --target wasm32-unknown-unknown --example basic_ui

Compatibility

bevy	bevy_cosmic_edit
0.13.0	0.16 - latest
0.12.*	0.15
0.11.*	0.8 - 0.14

Feature flags

• multicam — Enable to avoid panicing when multiple cameras are used in the same world Requires you to add CosmicPrimaryCamera marker component to the primary camera

License

MIT or Apache-2.0

Re-exports

• pub use cosmic_text::Action;
• pub use cosmic_text::Attrs;
• pub use cosmic_text::AttrsOwned;
• pub use cosmic_text::Buffer;
• pub use cosmic_text::CacheKeyFlags;
• pub use cosmic_text::Color as CosmicColor;
• pub use cosmic_text::Cursor;
• pub use cosmic_text::Edit;
• pub use cosmic_text::Editor;
• pub use cosmic_text::Family;
• pub use cosmic_text::FamilyOwned;
• pub use cosmic_text::FontSystem;
• pub use cosmic_text::Metrics;
• pub use cosmic_text::Shaping;
• pub use cosmic_text::Stretch;
• pub use cosmic_text::Style as FontStyle;
• pub use cosmic_text::Weight as FontWeight;

Structs

• BufferSet
  Set of all buffer setup functions. Runs in First
• ClickTimer
  Timer for double / triple clicks
• CosmicBackgroundColor
  Color to be used as a buffer’s background
• CosmicBackgroundImage
  Image to be used as a buffer’s background
• CosmicBuffer
  Component wrapper for Buffer
• CosmicEditBundle
  A bundle containing all the required components for CosmicBuffer functionality.
• CosmicEditPlugin
  Plugin struct that adds systems and initializes resources related to cosmic edit functionality.
• CosmicEditor
  Wrapper component for an Editor with a few helpful values for cursor blinking
• CosmicFontConfig
  Resource struct that holds configuration options for cosmic fonts.
• CosmicFontSystem
  Holds the font system used internally by cosmic_text
• CosmicPadding
  Wrapper for a Vec2 describing the horizontal and vertical padding of a widget. This is set programatically, not for user modification. To set a widget’s padding, use CosmicTextAlign
• CosmicSource
  A pointer to an entity with a CosmicEditBundle, used to apply cosmic rendering to a UI element.
• CosmicTextChanged
  Text change events Sent when text is changed in a cosmic buffer Contains the entity on which the text was changed, and the new text as a String
• CosmicWidgetSize
  Wrapper for a Vec2 describing the horizontal and vertical size of a widget. This is set programatically, not for user modification. To set a widget’s size, use either it’s Sprite dimensions or modify the target UI element’s size.
• CursorColor
  Color to be used for the text cursor
• CursorPlugin
• CursorPluginDisabled
  Unit resource whose existence in the world disables the cursor plugin systems.
• CursorSet
  System set for mouse cursor systems. Runs in Update
• DefaultAttrs
  Default text attributes to be used on a CosmicBuffer
• FocusSet
  System set for focus systems. Runs in PostUpdate
• FocusedWidget
  Resource struct that keeps track of the currently active editor entity.
• HoverCursor
• InputSet
  System set for mouse and keyboard input events. Runs in PreUpdate and Update
• MaxChars
  Maximum number of characters allowed in a buffer
• MaxLines
  Maximum number of lines allowed in a buffer
• Password
  Component to be added to an entity with a CosmicEditBundle to block contents with a password blocker glyph
• PasswordSet
  System set for password blocking systems. Runs in PostUpdate
• Placeholder
  Component to be added to an entity with a CosmicEditBundle add placeholder text
• ReadOnly
  Tag component to disable writing to a CosmicBuffer
• RenderSet
  System set for cosmic text rendering systems. Runs in PostUpdate
• ScrollDisabled
  Buffer does not respond to scroll events
• SelectedTextColor
  Color to be used for the selected text
• SelectionColor
  Color to be used as the selected text background
• TextHoverIn
  For use with custom cursor control Event is emitted when cursor enters a text widget Event contains the cursor from the buffer’s HoverCursor
• TextHoverOut
  For use with custom cursor control Event is emitted when cursor leaves a text widget
• UserSelectNone
  Tag component to disable user selection Like CSS user-select: none https://developer.mozilla.org/en-US/docs/Web/CSS/user-select
• WasmPaste
  Crossbeam channel struct for Wasm clipboard data
• WasmPasteAsyncChannel
  Async channel for receiving from the clipboard in Wasm
• WidgetSet
  System set for cosmic text layout systems. Runs in PostUpdate
• XOffset
  Internal value used to decide what section of a Buffer to render

Enums

• CosmicTextAlign
  Enum representing the text alignment in a cosmic Buffer
• CosmicWrap
  Enum representing text wrapping in a cosmic Buffer

Traits

• BufferExtras
• ColorExtras
  Trait for adding color conversion from bevy::prelude::Color to cosmic_text::Color

Functions

• add_font_system
  Adds a FontSystem to a newly created CosmicBuffer if one was not provided
• change_active_editor_sprite
  System to allow focus on click for sprite widgets
• change_active_editor_ui
  System to allow focus on click for UI widgets
• deselect_editor_on_esc
  System to unfocus editors when [Esc] is pressed
• get_node_cursor_pos
  Function to find the location of the mouse cursor in a cosmic widget
• get_text_size
• get_timestamp
  Utility function to get the current unix timestamp
• get_x_offset_center
• get_y_offset_center
• kb_clipboard
• kb_move_cursor
• print_editor_text
  System to print editor text content on change
• set_editor_redraw
  Initialises new CosmicEditor redraw flag to true
• set_initial_scale
  Initialises CosmicBuffer scale factor
• set_redraw
  Initialises new CosmicBuffer redraw flag to true
• swap_target_handle
  Sets image of UI elements to the CosmicBuffer output