Skip to content

Provide automated installation instructions with the new CLI command #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ealmloff merged 2 commits into from
Oct 21, 2025
Merged

Provide automated installation instructions with the new CLI command #139

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f43b2c2
provide automated instalation instructions
ealmloff Oct 21, 2025
65d88c0
fix clippy
ealmloff Oct 21, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
98 changes: 88 additions & 10 deletions preview/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,35 +716,60 @@ fn ComponentDemo(iframe: Option<bool>, dark_mode: Option<bool>, name: String) ->
#[component]
fn ComponentHighlight(demo: ComponentDemoData) -> Element {
let ComponentDemoData {
name,
name: raw_name,
docs,
variants,
component,
style,
} = demo;
let name = name.replace("_", " ");
let name = raw_name.replace("_", " ");
let [main, variants @ ..] = variants else {
unreachable!("Expected at least one variant for component: {}", name);
};

rsx! {
main { class: "component-demo",
h1 { class: "component-title", {name} }
h1 { class: "component-title", "{name}" }
div { class: "component-preview",
div { class: "component-preview-contents",
ComponentVariantHighlight { variant: main.clone(), main_variant: true }
div { class: "component-installation",
h2 { "Installation" }
ol { class: "component-installation-list",
li {
"If you haven't already, add the dx-components-theme.css file to your project and import it in the root of your app."
Tabs {
default_value: "Automatic",
border_bottom_left_radius: "0.5rem",
border_bottom_right_radius: "0.5rem",
horizontal: true,
width: "100%",
variant: TabsVariant::Ghost,
TabList {
TabTrigger { value: "Automatic", index: 0usize, "Automatic" }
TabTrigger { value: "Manual", index: 1usize, "Manual" }
}
div {
width: "100%",
height: "100%",
display: "flex",
flex_direction: "column",
justify_content: "center",
align_items: "center",
TabContent {
index: 0usize,
value: "Automatic",
width: "100%",
position: "relative",
CliComponentInstallation { name: raw_name }
}
TabContent {
index: 1usize,
value: "Manual",
width: "100%",
position: "relative",
ManualComponentInstallation { component, style }
}
}
li { "Add the style.css file to your project." }
li { "Create a component based on the main.rs below." }
li { "Modify your components and styles as needed." }
}
}
ComponentCode { rs_highlighted: component, css_highlighted: style }
div { class: "component-description",
div { dangerous_inner_html: docs }
}
Expand All @@ -760,6 +785,59 @@ fn ComponentHighlight(demo: ComponentDemoData) -> Element {
}
}

#[component]
fn ManualComponentInstallation(component: HighlightedCode, style: HighlightedCode) -> Element {
rsx! {
ol { class: "component-installation-list",
li {
"If you haven't already, add the dx-components-theme.css file to your project and import it in the root of your app."
}
li { "Add the style.css file to your project." }
li { "Create a component based on the main.rs below." }
li { "Modify your components and styles as needed." }
}
ComponentCode { rs_highlighted: component, css_highlighted: style }
}
}

#[component]
fn CliComponentInstallation(name: String) -> Element {
rsx! {
ol { class: "component-installation-list",
li {
"Install the 0.7.0-rc.3 version of the CLI manually (without binstall)"
div { id: "hero-installation",
"> "
div {
width: "100%",
display: "flex",
flex_direction: "row",
justify_content: "space-between",
align_items: "center",
"cargo install [email protected]"
CopyButton {}
}
}
}
li {
"Add the component to your project using the dx components add command:"
div { id: "hero-installation",
"> "
div {
width: "100%",
display: "flex",
flex_direction: "row",
justify_content: "space-between",
align_items: "center",
"dx components add {name}"
CopyButton {}
}
}
}
}
}
}

#[component]
fn ComponentVariantHighlight(variant: ComponentVariantDemoData, main_variant: bool) -> Element {
let ComponentVariantDemoData {
Expand Down
Loading