From 06814dc17bca88f292cadc8fa996a818bde4371f Mon Sep 17 00:00:00 2001 From: Leonard Date: Tue, 3 Oct 2023 13:59:53 +0200 Subject: [PATCH] Update core-macro README per #1448 (#1510) --- packages/core-macro/README.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/packages/core-macro/README.md b/packages/core-macro/README.md index 31b0cca90..497c7c587 100644 --- a/packages/core-macro/README.md +++ b/packages/core-macro/README.md @@ -23,9 +23,12 @@ `dioxus-core-macro` provides a handful of helpful macros used by the `dioxus` crate. These include: -- The `rsx!` macro that underpins templates and node creation -- The `inline_props` macro transforms function arguments into an auto-derived struct -- The `format_args_f` macro which allows f-string formatting with support for expressions +- The `rsx!` macro that underpins templates and node creation. +- The `component` attribute macro denotes a function as a Dioxus component. Currently, this: + - Transforms function arguments into an auto-derived struct. + - Ensures that your component name uses PascalCase. + - Probably more stuff in the future. This macro allows us to have a way of distinguishing functions and components, which can be quite handy. +- The `format_args_f` macro which allows f-string formatting with support for expressions. ## Contributing