Struct BrowserState 

pub struct BrowserState { /* private fields */ }

A browser: a tab strip, back, forward and reload buttons, an address field, and the selected tab’s page in a WebFrame.

It is a view that fills its parent: open it with BrowserState::open and place the entity as a child. It repaints itself when a tab opens, closes or changes. It always has at least one tab, since closing the last one opens the home page again. The pages are native views, so the same limits as WebView apply.

Implementations

impl BrowserState

pub fn open( home: impl Into<SharedString>, window: &mut Window, cx: &mut App, ) -> Result<Entity<Self>>

A browser with one tab on home, which a new tab opens as well.

Errors

If the platform cannot create the first native web view. See WebView::build for the setup each platform needs.

pub fn open_tab( &mut self, url: impl Into<String>, window: &mut Window, cx: &mut Context<'_, Self>, ) -> Result<SharedString>

Opens a tab on url and selects it. Returns its id.

Errors

If the browser holds 32 tabs, or the platform cannot create the native web view.

pub fn navigate(&mut self, text: impl AsRef<str>, cx: &mut Context<'_, Self>)

Navigates the selected tab. Text with a scheme loads as it is, text that looks like a host gets https://, and anything else is a web search.

pub fn back(&mut self, cx: &mut Context<'_, Self>)

Goes back in the selected tab’s history.

pub fn forward(&mut self, cx: &mut Context<'_, Self>)

Goes forward in the selected tab’s history.

pub fn reload(&mut self, cx: &mut Context<'_, Self>)

Reloads the selected tab.

pub fn close_tab( &mut self, id: impl Into<SharedString>, cx: &mut Context<'_, Self>, )

Closes the tab with id.

pub fn tabs(&self) -> &Entity<TabsState>

The tab strip’s state, to observe or to select a tab.

pub fn url(&self, cx: &App) -> Option<SharedString>

The address of the selected tab, if there is one.

Trait Implementations

impl EventEmitter<BrowserEvent> for BrowserState

impl Render for BrowserState

fn render( &mut self, _: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.