Raxol.Plugins.SearchPlugin (Raxol v0.4.0)

View Source

Plugin for text search functionality.

Summary

Functions

Gets the current search result.

Gets the current result index.

Gets the current search results.

Gets the current search term.

Highlights the search term in the given text.

Types

t()

@type t() :: %Raxol.Plugins.SearchPlugin{
  api_version: String.t(),
  config: map(),
  current_result_index: integer(),
  dependencies: [map()],
  description: String.t(),
  enabled: boolean(),
  name: String.t(),
  search_results: [any()],
  search_term: String.t() | nil,
  version: String.t()
}

Functions

get_current_result(plugin)

Gets the current search result.

get_current_result_index(plugin)

Gets the current result index.

get_search_results(plugin)

Gets the current search results.

get_search_term(plugin)

Gets the current search term.

highlight_search_term(text, search_term)

Highlights the search term in the given text.