Skip to content

Commit 6593ba6

Browse files
docs: add component description
1 parent 1a38227 commit 6593ba6

File tree

5 files changed

+8
-4
lines changed

5 files changed

+8
-4
lines changed

packages/core/src/components/actionLabel/ActionLabel.tsx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ export interface ActionLabelProps extends AriaProps, CssProp, ChildProp {
4242
actions: ReactElement[];
4343
}
4444

45+
/**
46+
* A simple label component with additional actions (like a button or icon) that becomes visible only when the user hovers over the label, useful in interfaces where space is limited or where it's important to keep the UI clean and focused
47+
*/
4548
export const ActionLabel = ({
4649
children,
4750
className,

packages/core/src/core/page/Page.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ export interface PageProps extends IconProps, ChildrenProp, TestProps {
4747
}
4848

4949
/**
50-
* Route page with section areas
50+
* The page component used typically for routes, is a structured layout used within an application to organize and display content in a sectioned format, ensuring a consistent and intuitive user experience.
5151
*/
5252
export const Page = ({
5353
children,

packages/core/src/core/section/Section.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ import { ErrorBoundary } from "../boundary/ErrorBoundary";
2727
import classes from "./Section.module.css";
2828

2929
/**
30-
* Application viewport
30+
* The section component provides a structured layout used within a page to organize and display content in a sectioned format, ensuring a consistent and intuitive user experience.
3131
*/
3232
export const Section = ({ children }: ChildrenProp) => {
3333
return (

packages/core/src/core/viewport/Viewport.tsx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { type PropsWithChildren } from "react";
2626
import classes from "./Viewport.module.css";
2727

2828
/**
29-
* Application viewport
29+
* The application viewport is the main container that defines the visible area where content is displayed and interacted with.
3030
*/
3131
export const Viewport = ({ children }: PropsWithChildren) => {
3232
return (

packages/core/stories/0.core/Core.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@ import {
2121
ErrorBoundary,
2222
Page,
2323
Section,
24+
Viewport,
2425
} from "../../src";
2526
import * as PageStories from "./Page.stories";
2627
import * as ContentStories from "./Content.stories";
@@ -38,7 +39,7 @@ import * as ThemeStories from "./Theme.stories";
3839
<Anchor storyId="viewport">
3940
<Subheading>Viewport</Subheading>
4041
</Anchor>
41-
<Description of={Page} />
42+
<Description of={Viewport} />
4243
<Canvas withToolbar of={ViewportStories._Viewport} />
4344
<Collapsable className="control-panel">
4445
<div>Controls</div>

0 commit comments

Comments
 (0)