Skip to main content
Version: Next

Editor Setup

contribute

Using a different editor? Feel free to add instructions for your editor of choice.

Add a template for creating components

JetBrains IDEs

  1. Navigate to File | Settings | Editor | Live Templates.
  2. Select Rust and click on the + icon to add a new Live Template.
  3. Give it a name and description of your preference.
  4. Paste the following snippet(s) into the Template Text section.
  5. Change the applicability on the lower right, select Rust > Item > Module

For function components, use the following template.

  • (Optional) Click on Edit Variable and give tag a reasonable default value like "div", with double quotes.
#[derive(PartialEq, Properties)]
pub struct $Name$Props {
}

#[function_component]
pub fn $Name$(props: &$Name$Props) -> Html {
html! {
<$tag$>$END$</$tag$>
}
}

For struct components, you can use the following more complicated template.

struct $NAME$;

enum $NAME$Msg {
}

impl Component for $NAME$ {
type Message = $NAME$Msg;
type Properties = ();

fn create(ctx: &Context<Self>) -> Self {
Self
}

fn view(&self, ctx: &Context<Self>) -> Html {
html! {
$HTML$
}
}
}

VS Code

  1. Navigate to File > Preferences > User Snippets.
  2. Select Rust as the language.
  3. Add the following snippet in the snippet JSON file:
{
"New Yew function component": {
"prefix": "yewfc",
"body": [
"#[derive(PartialEq, Properties)]",
"pub struct ${1:ComponentName}Props {}",
"",
"#[function_component]",
"pub fn $1(props: &${1}Props) -> Html {",
" let ${1}Props {} = props;",
" html! {",
" <${2:div}>$0</${2}>",
" }",
"}"
],
"description": "Create a minimal Yew function component"
},
"New Yew struct component": {
"prefix": "yewsc",
"body": [
"pub struct ${1:ComponentName};",
"",
"pub enum ${1}Msg {",
"}",
"",
"impl Component for ${1} {",
" type Message = ${1}Msg;",
" type Properties = ();",
"",
" fn create(ctx: &Context<Self>) -> Self {",
" Self",
" }",
"",
" fn view(&self, ctx: &Context<Self>) -> Html {",
" html! {",
" $0",
" }",
" }",
"}"
],
"description": "Create a new Yew component with a message enum"
}
}

Support for the html! Macro

JetBrains IDEs

JetBrains added experimental support for proc-macro expansion in April 2021. This feature must be enabled before it can be used. See the blog post here.

This still won't enable HTML autofill and formatting help, although it will enable variable resolution for component names and attributes inside the macro. Utilities like Rename, Go to Declaration, Find Usages will work inside the macro.

VS Code

There isn't support for the specialized syntax of html!. However, the default HTML IntelliSense can be used by adding this to your settings.json file:

"emmet.includeLanguages": {
"rust": "html",
}