From c1b2df01f37e23ff30232baf70799c0fe6a6fe7b Mon Sep 17 00:00:00 2001 From: prototypa Date: Thu, 27 Jul 2023 14:49:22 -0400 Subject: [PATCH] Fix minor typos --- .../post/astrowind-template-in-depth.mdx | 261 +++++++++--------- 1 file changed, 138 insertions(+), 123 deletions(-) diff --git a/src/content/post/astrowind-template-in-depth.mdx b/src/content/post/astrowind-template-in-depth.mdx index 5275e52..3b47fc2 100644 --- a/src/content/post/astrowind-template-in-depth.mdx +++ b/src/content/post/astrowind-template-in-depth.mdx @@ -11,142 +11,162 @@ tags: - front-end canonical: https://astrowind.vercel.app/astrowind-template-in-depth --- -import DListItem from "../../components/widgets/DListItem.astro"; -import ToggleTheme from "../../components/common/ToggleTheme.astro"; + +import DListItem from '../../components/widgets/DListItem.astro'; +import ToggleTheme from '../../components/common/ToggleTheme.astro'; ## Overview It can be a somewhat daunting task trying to get a handle on _AstroWind_ internals, and particularly various points of usage. -This page outlines and clarifies some of the techniques found in _AstroWind_. Use it as a guide for further modification, or an instructional for techniques to use in your own endeavors. +This page outlines and clarifies some of the techniques found in _AstroWind_. Use it as a guide for further modification, or an instructional for techniques to use in your own endeavors. ## Styling -As the name suggests, _AstroWind_ relies on _TailWind_ for styling. Furthermore, _AstroWind_ defines custom low level style settings which are incorporated into _TailWind_ seamlessly, and which provides consistency for higher level styling constructs, as well as enabling dark mode. +As the name suggests, _AstroWind_ relies on _TailWind_ for styling. Furthermore, _AstroWind_ defines custom low level style settings which are incorporated into _TailWind_ seamlessly, and which provides consistency for higher level styling constructs, as well as enabling dark mode. The styling mechanism consists of the following files (all paths are prefixed with `/src/` ): - This file is essentially an extension of _TailWind's_ base.css. High-level component styles are defined here. - - Note also styling on elements selected by 'attribute' selectors at the bottom of the files, particularly those selected by 'data' attributes. + This file is essentially an extension of _TailWind's_ base.css. High-level component styles are defined here. Note + also styling on elements selected by 'attribute' selectors at the bottom of the files, particularly those selected by + 'data' attributes. - Defines custom colors and fonts. For these to take effect in the 'base.css' file, they need to be loaded in the html header section. See next. + Defines custom colors and fonts. For these to take effect in the 'base.css' file, they need to be loaded in the html + header section. See next. - Instantiates the _CustomStyles.astro_ component, along with other meta information (as the name implies). All of this is injected in to the header - see next. + Instantiates the _CustomStyles.astro_ component, along with other meta information (as the name implies). All of this + is injected in to the header - see next. - This layout is used for all of the pages rendered by _AstroWind_. The contents of _MetaTags.astro_ component, described above, is injected into the html header. + This layout is used for all of the pages rendered by _AstroWind_. The contents of _MetaTags.astro_ component, + described above, is injected into the html header. ### Dark Mode _Dark Mode_ is triggered by the little 'sunlight' icon:in the page header. It is defined in the _components/common/ToggleTheme.astro_, but the event is attached and the action defined in _components/common/BasicScripts.astro_ in the following snippet: + ```javascript - attachEvent('[data-aw-toggle-color-scheme]', 'click', function () { - if (defaultTheme.endsWith(':only')) { - return; - } - document.documentElement.classList.toggle('dark'); - localStorage.theme = document.documentElement.classList.contains('dark') ? 'dark' : 'light'; - }); +attachEvent('[data-aw-toggle-color-scheme]', 'click', function () { + if (defaultTheme.endsWith(':only')) { + return; + } + document.documentElement.classList.toggle('dark'); + localStorage.theme = document.documentElement.classList.contains('dark') ? 'dark' : 'light'; +}); ``` -Note that this is a client event. _BasicScripts.astro_ defines several other client-side functionality as well as this one. + +Note that this is a client event. _BasicScripts.astro_ defines several other client-side functionality as well as this one. ## Advanced Slot Usage -_slots_ are part of the component implementation, which is a common concept among many frameworks, including _Astrojs_. The typical slot definition in a component looks like this: -```astro - // (file: MyComponent.astro) - --- - const {title} = Astro.props; - interface Props = { - title:string - } - --- -
-

{title}

- -
-``` -And in usage elsewhere: +_slots_ are part of the component implementation, which is a common concept among many frameworks, including _Astrojs_. The typical slot definition in a component looks like this: + ```astro - import MyComponent from "~/components/MyComponent"; - ... - -

This content will be displayed in the slot

- +--- +// (file: MyComponent.astro) +const { title } = Astro.props; +export interface Props { + title: string; +} +--- + +
+

{title}

+ + +
+
``` + +And in usage elsewhere: + +```astro +import MyComponent from "~/components/MyComponent"; ... + +

This content will be displayed in the slot

+ +``` + ### Alternate usage + There's another way we can use slots, useful particularly when a component can have markdown content is as follows (study carefully...): -```astro - // (file: MyComponent.astro) - --- - const {title} = Astro.props; - interface Props = { - title:string - } +```astro +--- +// (file: MyComponent.astro) - const content:string = await Astro.props.render('default'); - // renders the html to the 'content' variable - --- -
-

{title}

-
-
+const { title } = Astro.props; +export interface Props { + title: string; +} +const content: string = await Astro.props.render('default'); +--- + +// renders the html to the 'content' variable +
+

{title}

+
+ +
+
``` + Whoa!! What's going on here? -Notice there is no slot definition in the html portion of the component. Instead, what we do is have _Astro_ render the slot content (here, the 'default' content, but you can also render named slots) into a variable, and then use that content in a _div_ (for instance). +Notice there is no slot definition in the html portion of the component. Instead, what we do is have _Astro_ render the slot content (here, the 'default' content, but you can also render named slots) into a variable, and then use that content in a _div_ (for instance). So, if the usage is in a markdown file, like so: ```mdx - import MyComponent from '../../components/MyComponent'; +import MyComponent from '../../components/MyComponent'; - # Using the above component in a .mdx file (that can take components) +# Using the above component in a .mdx file (that can take components) - - ### Here is some markdown content - - With a bullet item. - +{' '} + +### Here is some markdown content - With a bullet item. ``` + _MyComponent_ renders the markdown to html and then injects it into the div. -This actually has a big advantage -- consider that with the normal usage you don't have access to the slot contents: _Astro_ just plops the content into the _<slot/>_ tag. Using this method, however, allows you to access the content and further manipulate it before it gets inserted into the html. +This actually has a big advantage -- consider that with the normal usage you don't have access to the slot contents: _Astro_ just plops the content into the _<slot/>_ tag. Using this method, however, allows you to access the content and further manipulate it before it gets inserted into the html. This allows a great deal of flexibility in component design. ### Yet Another Step -Now, we get to the techniques used in _AstroWind_, we'll use the _pages/index.astro_ file to illustrate. +Now, we get to the techniques used in _AstroWind_, we'll use the _pages/index.astro_ file to illustrate. -You'll note that the index file imports a lot of components, each one roughly analagous to a panel in the index page. Each of these components, in turn, is instantiated sequentially throughout the page. But, you'll notice that some of them use this kind of construct (we'll use the last section, _CallToAction_, as it is most illustrative of the technique): +You'll note that the index file imports a lot of components, each one roughly analagous to a panel in the index page. Each of these components, in turn, is instantiated sequentially throughout the page. But, you'll notice that some of them use this kind of construct (we'll use the last section, _CallToAction_, as it is most illustrative of the technique): ```astro - - - Astro +
Tailwind CSS - + + + Astro +
Tailwind CSS + - - Be very surprised by these huge fake numbers you are seeing on this page. Don't - waste more time! :P - - + + Be very surprised by these huge fake numbers you are seeing on this page. Don't waste + more time! :P + + ``` + Some things to note, here: + - This argument is actually being passed a javascript object -- not a string. (However, in the TS definition, it could be a string...) + This argument is actually being passed a javascript object -- not a string. (However, in the TS definition, it could + be a string...) Furthermore, these <Fragment/> elements each have a _slot="(value)"_ specifier. @@ -159,38 +179,39 @@ The answer lies in a paragraph in the _Astro_ docs, slots section, which states: > Use a `slot="my-slot"` attribute on the child element that you want to pass through to a matching slot `name="my-slot" />` placeholder in your component. That's pretty concise and a bit of a head-scratcher to read, but basically what it says is that: - 1. Given a component that defines a slot: - 1. you can reference a slot from a child element of that component and, - 1. provide content to the parent component's slot from the child by naming the slot in the child with a `slot=""` property assignment, where the _slot-name_ is the parent's slot. + +1. Given a component that defines a slot: +1. you can reference a slot from a child element of that component and, +1. provide content to the parent component's slot from the child by naming the slot in the child with a `slot=""` property assignment, where the _slot-name_ is the parent's slot. So, in the example above, the _CallToAction_ component defines the _subtitle_ slot, and the following _<Fragment slot="subtitle">_ populates the slot with the following content: ```astro - - Be very surprised by these huge fake numbers you are seeing on this page. Don't - waste more time! :P - + + Be very surprised by these huge fake numbers you are seeing on this page. Don't waste + more time! :P + ``` And, the _CallToAction_ component defines and renders it thusly: ```astro --- - ... - const { - subtitle = await Astro.slots.render('subtitle'), -} = Astro.props; +//... +const { subtitle = await Astro.slots.render('subtitle') } = Astro.props; --- - ... - {subtitle &&

} - ... +//... +{subtitle &&

} + //... ``` + There's a lot to wrap your head around, here. -Notice first that _subtitle_ is defined as a prop/argument, but it's being processed as a slot. Interestingly, prop args and slots seem to be somewhat interchangeable: if the subtitle was just a string, it would simply take that assignment. The main difference is that if you render them independently, you have to call the render with an _await_ modifier. +Notice first that _subtitle_ is defined as a prop/argument, but it's being processed as a slot. Interestingly, prop args and slots seem to be somewhat interchangeable: if the subtitle was just a string, it would simply take that assignment. The main difference is that if you render them independently, you have to call the render with an _await_ modifier. ## CallToAction Property + @@ -198,52 +219,46 @@ Notice first that _subtitle_ is defined as a prop/argument, but it's being proce There's a _lot_ of duplicate (or at least very similar code) in the following components, especially as regards the _CallToAction_ mechanism -- adding to a lot of confusion and something of a maintenance headache:
-src/components/widgets/Hero.astro -src/components/widgets/Steps2.astro -src/components/widgets/CallToAction.astro -src/components/widgets/Hero2.astro -src/pages/landing/startup.astro + src/components/widgets/Hero.astro src/components/widgets/Steps2.astro src/components/widgets/CallToAction.astro + src/components/widgets/Hero2.astro src/pages/landing/startup.astro
Seems like this could be cleaned up. +
Note:
The _CallToAction_ property can be of type `string | CallToAction` where the `CallToAction` is a typed object. In the component, this is handled thusly: + ```astro --- - const { - callToAction = await Astro.slots.render('callToAction'), - } = Astro.props; - // also rendered as a slot +const { callToAction = await Astro.slots.render('callToAction') } = Astro.props; +// also rendered as a slot --- -

+ +
... { - typeof callToAction === 'string' ? ( - - ) : ( - callToAction && - callToAction.text && - callToAction.href && ( -
- - {callToAction.icon && } - {callToAction.text} - -
+ typeof callToAction === 'string' ? ( + + ) : ( + callToAction && + callToAction.text && + callToAction.href && ( +
+ + {callToAction.icon && } + {callToAction.text} + +
+ ) ) - ) -} -
+ } +
``` + First, the property type is checked to see if it's a string: if so, it's just set into a child _<Fragment>'s_ html. If not, it is validated as an object and then members of the object are assigned to various html elements. - - - - -