-
Notifications
You must be signed in to change notification settings - Fork 85
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(website): document how to write closed components
- Loading branch information
1 parent
f1c69b7
commit a51597b
Showing
4 changed files
with
90 additions
and
6 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
import { UserIcon } from 'lucide-react' | ||
import { forwardRef } from 'react' | ||
import { Avatar as ArkAvatar } from '../' | ||
|
||
export interface AvatarProps extends ArkAvatar.RootProps { | ||
name?: string | ||
src?: string | ||
} | ||
|
||
export const Avatar = forwardRef<HTMLDivElement, AvatarProps>((props, ref) => { | ||
const { name, src, ...rootProps } = props | ||
return ( | ||
<ArkAvatar.Root ref={ref} {...rootProps}> | ||
<ArkAvatar.Fallback>{getInitials(name) || <UserIcon />}</ArkAvatar.Fallback> | ||
<ArkAvatar.Image src={src} alt={name} /> | ||
</ArkAvatar.Root> | ||
) | ||
}) | ||
|
||
const getInitials = (name = '') => | ||
name | ||
.split(' ') | ||
.map((part) => part[0]) | ||
.slice(0, 2) | ||
.join('') | ||
.toUpperCase() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
import { UserIcon } from 'lucide-solid' | ||
import { Show, splitProps } from 'solid-js' | ||
import { Avatar as ArkAvatar } from '../..' | ||
|
||
export interface AvatarProps extends ArkAvatar.RootProps { | ||
name?: string | ||
src?: string | ||
} | ||
|
||
export const Avatar = (props: AvatarProps) => { | ||
const [localProps, rootProps] = splitProps(props, ['name', 'src']) | ||
|
||
return ( | ||
<ArkAvatar.Root {...rootProps}> | ||
<ArkAvatar.Fallback> | ||
<Show when={localProps.name} fallback={<UserIcon />}> | ||
{getInitials(localProps.name)} | ||
</Show> | ||
</ArkAvatar.Fallback> | ||
<ArkAvatar.Image src={localProps.src} alt={localProps.name} /> | ||
</ArkAvatar.Root> | ||
) | ||
} | ||
|
||
const getInitials = (name = '') => | ||
name | ||
.split(' ') | ||
.map((part) => part[0]) | ||
.splice(0, 2) | ||
.join('') | ||
.toUpperCase() |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
--- | ||
id: closed-components | ||
title: Closed Components | ||
description: Learn how to create reusable components using the example of an avatar | ||
--- | ||
|
||
## Motivation | ||
|
||
Writing a few lines of code every time you need a simple `Avatar` is tedious. | ||
Creating a dedicated component encapsulates logic, simplifies the API, ensures consistent usage, and maintains clean code. | ||
This approach enhances reusability, making the component easier to maintain and test. | ||
|
||
Here's an example of an `Avatar` component that can be used consistently across your application: | ||
|
||
<Example id="closed" component="avatar" /> | ||
|
||
## Usage | ||
|
||
To use the `Avatar` component, pass the `name` and `src` props as shown below: | ||
|
||
```jsx | ||
<Avatar | ||
name="Christian" | ||
src="https://avatars.githubusercontent.com/u/1846056?v=4" | ||
/> | ||
``` |