@xyd-js/components 0.1.0-xyd.7 → 0.1.0-xyd.94

package/src/writer/GuideCard/GuideCard.styles.tsx

@@ -1,115 +1,116 @@
-import {css} from "@linaria/core";
-
-export const $guide = {
-    host: css`
-    `,
-    host$$secondary: css`
-        //flex-grow: 1;
-        //width: 100%;
-        display: flex;
-        position: relative;
-        overflow: hidden;
-        border: .5px solid #ececf1;
-        background: linear-gradient(238deg, rgba(247, 247, 248, .5) 0%, rgba(247, 247, 248, 1) 100%);
-        border-radius: 8px;
-        padding: 16px 20px 20px;
-        z-index: 0;
-        transition: box-shadow .2s ease-in-out, background-image .2s ease;
-
-        &:hover {
-            background: linear-gradient(238deg, rgba(255, 255, 255, .5) 0%, rgba(250, 250, 250, 1) 100%);
+import { css } from "@linaria/core";
+
+export const GuideHost = css`
+    @layer defaults {
+        display: block;
+
+        &[data-kind="secondary"] {
+            display: flex;
+            position: relative;
+            overflow: hidden;
+            border: 1px solid var(--xyd-guidecard-border-color--secondary);
+            background: var(--xyd-guidecard-bgcolor--secondary);
+            border-radius: 8px;
+            padding: 24px;
+            z-index: 0;
+            transition: box-shadow .2s ease-in-out, background-image .2s ease;
+
+            &:hover {
+                background: var(--xyd-guidecard-bgcolor--secondary-hover);
+            }
+
+            &[data-size="md"] {
+                padding: 21px 25px 25px;
+            }
+        }
+
+        [part="link"] {
+            width: 100%;
+            height: 100%;
         }
-    `,
-    host$$secondary$$md: css`
-        padding: 21px 25px 25px;
-    `,
-    link: css`
-        width: 100%;
-        height: 100%;
-    `,
-    item: css`
-        border-radius: 8px;
-        display: flex;
-
-        align-items: flex-start;
-        cursor: pointer;
-        transition: opacity .15s;
-
-        &:hover {
-            [data-pointer="true"] {
-                opacity: 1;
-                transform: translate(0);
+
+        [part="item"] {
+            border-radius: 8px;
+            display: flex;
+
+            align-items: flex-start;
+            cursor: pointer;
+            transition: opacity .15s;
+
+            &:hover {
+                [part="pointer"] {
+                    opacity: 1;
+                    transform: translate(0);
+                }
             }
         }
-    `,
-    item$$secondary: css`
-        width: 100%;
-        height: 100%;
-    `,
-    icon: css`
-        line-height: 0px;
-        font-size: 24px;
-        border-radius: 8px;
-        width: 48px;
-        height: 48px;
-        display: flex;
-        justify-content: center;
-        align-items: center;
-        color: #353740;
-        border: 1px solid #ececf1;
-        background: linear-gradient(238deg, rgba(255, 255, 255, .5) 0%, rgba(250, 250, 250, 1) 100%);
-        transition: background .2s ease;
-        box-sizing: border-box;
-        flex-shrink: 0;
-    `,
-    right: css`
-        padding-left: 16px;
-        display: flex;
-        flex-direction: column;
-        gap: 4px;
-    `,
-    title: css`
-        display: flex;
-        color: #202123;
-        font-weight: 400;
-        align-items: center;
-        transition: color .15s;
-    `,
-    titleBody: css`
-        font-size: 16px;
-        line-height: 20px;
-    `,
-    titleBody$$md: css`
-        font-size: 18px;
-    `,
-    body: css`
-        font-weight: 400;
-        font-size: 14px;
-        line-height: 20px;
-
-        color: #6e6e80;
-        white-space: normal;
-        overflow: hidden;
-        text-overflow: ellipsis;
-    `,
-    body$$md: css`
-        font-size: 16px;
-    `,
-    pointer: css`
-        opacity: 0;
-        transform: translate(-4px);
-        display: flex;
-        justify-content: center;
-        transition: opacity .15s ease-in-out, transform .15s ease-in-out;
-    `
-}
+        &[data-kind="secondary"] [part="item"] {
+            width: 100%;
+            height: 100%;
+        }
+
+        [part="icon"] {
+            height: 32px;
+            display: flex;
+            justify-content: center;
+            align-items: center;
+            color: var(--xyd-guidecard-icon-color);
+            transition: background .2s ease;
+            box-sizing: border-box;
+            flex-shrink: 0;
 
+            svg {
+                width: 24px;
+                height: 24px;
+            }
+        }
+
+        [part="right"] {
+            padding-left: 16px;
+            display: flex;
+            flex-direction: column;
+            gap: 4px;
+        }
+
+        [part="title"] {
+            display: flex;
+            color: var(--xyd-guidecard-title-color);
+            align-items: center;
+            font-weight: var(--xyd-font-weight-semibold);
+            transition: color .15s;
+        }
+
+        [part="title-body"] {
+        }
+        &[data-size="md"] [part="title-body"] {
+        }
+
+        [part="body"] {
+            font-weight: var(--xyd-font-weight-normal);
+
+            color: var(--xyd-guidecard-color);
+            white-space: normal;
+            overflow: hidden;
+            text-overflow: ellipsis;
+        }
+        &[data-size="md"] [part="body"] {
+        }
+
+        [part="pointer"] {
+            opacity: 0;
+            transform: translate(-4px);
+            display: flex;
+            justify-content: center;
+            transition: opacity .15s ease-in-out, transform .15s ease-in-out;
+        }
+    }
+`;
 
-export const $list = {
-    host: css`
+export const GuideListHost = css`
+    @layer defaults {
         display: grid;
         grid-template-columns: 1fr 1fr;
         justify-content: center;
-        gap: 30px;
-    `
-}
+        gap: 24px;
+    }
+`;

package/src/writer/GuideCard/GuideCard.tsx

@@ -1,69 +1,95 @@
 import React from "react"
 
-import {$guide, $list} from "./GuideCard.styles";
+import * as cn from "./GuideCard.styles";
 
+/**
+ * Props for the GuideCard component
+ */
 export interface GuideCardProps {
+    /** Content to be displayed in the card body */
     children: React.ReactNode;
+
+    /** URL the card links to */
     href: string
+
+    /** Title displayed at the top of the card */
     title: string;
+
+    /** Optional icon displayed to the left of the content */
     icon?: React.ReactNode;
+
+    /** Visual style variant of the card */
     kind?: "secondary"
+
+    /** Size variant of the card */
     size?: "sm" | "md"
+
+    /** Additional CSS class names to apply to the card */
+    className?: string
+
+    /** Additional props to pass to the link element */
+    as?: React.ElementType
 }
 
+/**
+ * A card component that displays content with a title and optional icon.
+ * The entire card is clickable and links to the specified URL.
+ * 
+ * @category Component
+ */
 export function GuideCard({
-                              children,
-                              href,
-                              icon,
-                              title,
-                              kind,
-                              size,
+    children,
+    href,
+    icon,
+    title,
+    kind,
+    size,
+    className,
+    as,
+}: GuideCardProps) {
+    const Link = as || $Link
 
-                          }: GuideCardProps) {
-    return <div className={`
-        ${$guide.host}
-        ${kind === "secondary" && $guide.host$$secondary}
-        ${kind === "secondary" && size == "md" && $guide.host$$secondary$$md}
-    `}>
-        <a className={$guide.link} href={href}>
-            <div className={`
-                ${$guide.item}
-                ${kind === "secondary" && $guide.item$$secondary}
-            `}>
-                {icon && <div className={$guide.icon}>
+    return <xyd-guidecard
+        className={`${cn.GuideHost} ${className || ""}`}
+        data-kind={kind}
+        data-size={size}
+    >
+        <Link part="link" href={href}>
+            <div part="item">
+                {icon && <div part="icon">
                     {icon}
                 </div>}
-                <div className={$guide.right}>
-                    <div className={$guide.title}>
-                        <div className={`
-                            ${$guide.title} 
-                            ${$guide.titleBody}
-                            ${size == "md" && $guide.titleBody$$md}
-                        `}>
+                <div part="right">
+                    <div part="title">
+                        <div part="title-body">
                             {title}
                         </div>
-                        <$Pointer/>
+                        <$Pointer />
                     </div>
-                    <div className={`
-                        ${$guide.body}
-                        ${size == "md" && $guide.body$$md}
-                    `}>
+                    <div part="body">
                         {children}
                     </div>
                 </div>
             </div>
-        </a>
-    </div>
+        </Link>
+    </xyd-guidecard>
 }
 
-GuideCard.List = function GuideCardList({children}: { children: React.ReactNode }) {
-    return <div className={$list.host}>
+/**
+ * A container component for grouping multiple GuideCard components.
+ * Provides consistent spacing and layout for a list of guide cards.
+ */
+GuideCard.List = function GuideCardList({ children }: { children: React.ReactNode }) {
+    return <xyd-guidecard-list className={cn.GuideListHost}>
         {children}
-    </div>
+    </xyd-guidecard-list>
 }
 
+/**
+ * Internal component that renders the arrow pointer icon.
+ */
 function $Pointer() {
-    return <div data-pointer="true" className={$guide.pointer}>
+    return <div part="pointer">
         <svg
             xmlns="http://www.w3.org/2000/svg"
             width={24}
@@ -78,4 +104,13 @@ function $Pointer() {
             />
         </svg>
     </div>
+}
+
+function $Link({ href, children, ...rest }) {
+    return <a
+        href={href}
+        {...rest}
+    >
+        {children}
+    </a>
 }

package/src/writer/Heading/Heading.styles.tsx

@@ -1,73 +1,93 @@
-import {css} from "@linaria/core";
+import { css } from "@linaria/core";
 
-export const $heading = {
-    host: css`
-        line-height: 40px;
-        font-weight: 300;
-        color: #202123;
+export const HeadingHost = css`
+    @layer defaults {
+        color: var(--xyd-heading-color);
+        line-height: var(--xyd-line-height-xlarge);
+        font-weight: var(--xyd-font-weight-semibold);
 
         position: relative;
-        display: inline-block;
+        display: table;
         margin: 0;
         padding: 0 24px 0 0;
         scroll-margin-top: 30px;
-        cursor: pointer;
+        cursor: default;
+
+        &[id] {
+            cursor: pointer;
+        }
+        &[data-noanchor="true"] {
+            cursor: default;
+        }
+
+        &[data-has-label="true"] {
+            display: flex;
+            align-items: center;
+            gap: 8px;
+
+            xyd-badge {
+                font-size: var(--xyd-font-size-xsmall);
+                line-height: var(--xyd-line-height-xsmall);
+                letter-spacing: 2px;
+            }
+        }
 
         &:hover {
             svg {
                 opacity: 1;
             }
         }
-    `,
-    h1: css`
-        font-size: 36px;
 
-        code {
-            font-size: 30px;
+        &[data-kind="muted"] {
+            color: var(--xyd-heading-color--muted);
+            cursor: default;
+            font-weight: var(--xyd-font-weight-medium);
         }
-    `,
-    h2: css`
-        font-size: 30px;
 
-        code {
-            font-size: 24px;
+        &[data-size="1"] {
+            font-size: var(--xyd-font-size-2xl);
+            line-height: var(--xyd-line-height-2xl);
         }
-    `,
-    h3: css`
-        font-size: 26px;
 
-        code {
-            font-size: 22px;
+        &[data-size="2"] {
+            font-size: var(--xyd-font-size-xxlarge);
+            line-height: var(--xyd-line-height-xxlarge);
         }
-    `,
-    h4: css`
-        font-size: 22px;
 
-        code {
-            font-size: 18px;
+        &[data-size="3"] {
+            font-size: var(--xyd-font-size-xlarge);
+            line-height: var(--xyd-line-height-xlarge);
         }
-    `,
-    h5: css`
-        font-size: 18px;
 
-        code {
-            font-size: 14px;
+        &[data-size="4"] {
+            font-size: var(--xyd-font-size-large);
+            line-height: var(--xyd-line-height-large);
         }
-    `,
-    h6: css`
-        font-size: 16px;
 
-        code {
-            font-size: 12px;
+        &[data-size="5"] {
+            font-size: var(--xyd-font-size-medium);
+            line-height: var(--xyd-line-height-medium);
         }
-    `,
-    link: css`
-        position: absolute;
-        top: 50%;
-        right: 0;
-        margin-top: -6px;
-        opacity: 0;
-        color: #7051d4;
-        transition: opacity .15s ease;
-    `
-}
+
+        &[data-size="6"] {
+            font-size: var(--xyd-font-size-small);
+            line-height: var(--xyd-line-height-small);
+        }
+
+        [part="icon"] {
+            position: absolute;
+            top: 50%;
+            right: 0;
+            margin-top: -6px;
+            opacity: 0;
+            color: var(--xyd-heading-icon-color);
+            transition: opacity .15s ease;
+        }
+        &[data-active="true"] {
+            [part="icon"] {
+                opacity: 1;
+            }
+        }
+    }
+`;
+

package/src/writer/Heading/Heading.tsx

@@ -1,47 +1,117 @@
-import React, {useRef} from "react"
+import React, { } from "react"
 
-import {$heading} from "./Heading.styles";
+import * as cn from "./Heading.styles";
+import { Badge } from "writer";
 
+/**
+ * Props for the Heading component
+ * @interface HeadingProps
+ */
 export interface HeadingProps {
+    /** Content to be rendered inside the heading */
     children: React.ReactNode
+
+    /** The size of the heading (1-6, corresponding to h1-h6) */
     size: 1 | 2 | 3 | 4 | 5 | 6
+
+    /** Optional HTML element to render as (div or span) */
     as?: "div" | "span"
+
+    /** Optional ID for the heading element */
     id?: string
+
+    /** Optional visual style variant */
+    kind?: "muted"
+
+    /** Optional click handler */
     onClick?: () => void
+
+    /** Optional additional CSS class name */
+    className?: string
+
+    /** Optional active state */
+    active?: boolean
+
+    /** Optional label for the heading */
+    label?: string
+
+    /** Optional subtitle for the heading */
+    subtitle?: string
+
+    /** Optional to hide the anchor icon */
+    noanchor?: boolean
+
+    /** Optional ref for the heading element */
+    ref?: React.RefObject<HTMLHeadingElement>
+
+    style?: React.CSSProperties
 }
 
-export function Heading({children, size = 1, as, id, onClick}: HeadingProps) {
+/**
+ * A flexible heading component that can render as any heading level (h1-h6) or as a div/span
+ * 
+ * @category Component
+ */
+export function Heading(props: HeadingProps) {
+    const {
+        children,
+        size = 1,
+        as,
+        id,
+        onClick,
+        className,
+        kind,
+        active,
+        label,
+        subtitle,
+        noanchor,
+        ref,
+        style,
+    } = props
     let HeadingComponent = as ? as : `h${size}` as "h1" | "h2" | "h3" | "h4" | "h5" | "h6"
 
-    const obRef = useRef<HTMLAnchorElement>(null)
-
-    return <HeadingComponent
-        className={`
-            ${$heading.host}
-            ${size === 1 && $heading.h1}
-            ${size === 2 && $heading.h2}
-            ${size === 3 && $heading.h3}
-            ${size === 4 && $heading.h4}
-            ${size === 5 && $heading.h5}
-            ${size === 6 && $heading.h6}
-            xyd_comp-comp-heading
-        `}
-        onClick={onClick}
-    >
-        {children}
+    return <>
+        <HeadingComponent
+            style={style || undefined}
+            className={` ${cn.HeadingHost}  ${className || ''}`}
+            data-size={size}
+            data-kind={kind}
+            data-has-label={String(label ? "true" : "false")}
+            data-noanchor={String(noanchor || "false")}
+            data-active={String(active || "false")}
+            onClick={noanchor ? undefined : onClick}
+            id={id}
+            ref={ref}
+        >
+            {children}
+
+            {label && <Badge size="sm">{label}</Badge>}
+
+            {id && !noanchor && <$Anchor />}
+        </HeadingComponent>
 
-        {id && <$Anchor/>}
-    </HeadingComponent>
+        {
+            subtitle ? <Heading
+                {...props}
+                size={4}
+                kind="muted"
+                subtitle={undefined} 
+                label={undefined}
+            >
+                {subtitle}
+            </Heading> : null
+        }
+    </>
 }
 
 function $Anchor() {
     return <svg
+        part="icon"
         xmlns="http://www.w3.org/2000/svg"
         width={15}
         height={15}
         fill="currentColor"
         viewBox="0 0 24 24"
-        className={$heading.link}
         role="presentation"
     >
         <path

package/src/writer/Hr/Hr.styles.tsx

@@ -1,7 +1,7 @@
 import {css} from "@linaria/core";
 
-export const $hr = {
-    host: css`
-        border-color: rgb(229 229 229 / 0.7);
-    `
-}
+export const HrHost = css`
+    @layer defaults {
+        border: 0.5px solid var(--xyd-hr-border-color);
+    }
+`;

package/src/writer/Hr/Hr.tsx

@@ -1,13 +1,10 @@
 import React from "react"
 
-import {$hr} from "./Hr.styles";
+import * as cn from "./Hr.styles";
 
 export interface HrProps {
-    children: React.ReactNode;
 }
 
-export function Hr({children}: HrProps) {
-    return <hr className={$hr.host}>
-        {children}
-    </hr>
+export function Hr() {
+    return <hr part="hr" className={cn.HrHost}/>
 }