-
Notifications
You must be signed in to change notification settings - Fork 37
SEO #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
SEO #1
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
d47345d
canonical
CTNicholas 0d91c6f
robots
CTNicholas 83e66fd
sitemap
CTNicholas 5507d73
llms
CTNicholas f3e6552
description should be longer
CTNicholas d9597ca
make build work
CTNicholas 360eaf0
Update site/src/config.ts
CTNicholas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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,72 @@ | ||
| # Frimousse | ||
|
|
||
| A lightweight, unstyled, and composable emoji picker for React. | ||
|
|
||
| - ⚡️ **Lightweight and fast**: Dependency-free, tree-shakable, and virtualized with minimal re-renders | ||
| - 🎨 **Unstyled and composable**: Bring your own styles and compose parts as you want | ||
| - 🔄 **Always up-to-date**: Latest emoji data is fetched when needed and cached locally | ||
| - 🔣 **No � symbols**: Unsupported emojis are automatically hidden | ||
| - ♿️ **Accessible**: Keyboard navigable and screen reader-friendly | ||
|
|
||
| ## Installation | ||
|
|
||
| ```bash | ||
| npm i frimousse | ||
| ``` | ||
|
|
||
| If you are using [shadcn/ui](https://ui.shadcn.com/), you can also install it as a pre-built component via the [shadcn CLI](https://ui.shadcn.com/docs/cli). | ||
|
|
||
| ```bash | ||
| npx shadcn@latest add https://frimousse.liveblocks.io/r/emoji-picker | ||
| ``` | ||
|
|
||
| Learn more in the [shadcn/ui](#shadcnui) section. | ||
|
|
||
| ## Usage | ||
|
|
||
| Import the `EmojiPicker` parts and create your own component by composing them. | ||
|
|
||
| ```tsx | ||
| import { EmojiPicker } from "frimousse"; | ||
|
|
||
| export function MyEmojiPicker() { | ||
| return ( | ||
| <EmojiPicker.Root> | ||
| <EmojiPicker.Search /> | ||
| <EmojiPicker.Viewport> | ||
| <EmojiPicker.Loading>Loading…</EmojiPicker.Loading> | ||
| <EmojiPicker.Empty>No emoji found.</EmojiPicker.Empty> | ||
| <EmojiPicker.List /> | ||
| </EmojiPicker.Viewport> | ||
| </EmojiPicker.Root> | ||
| ); | ||
| } | ||
| ``` | ||
|
|
||
| Apart from a few sizing and overflow defaults, the parts don’t have any styles out-of-the-box. Being composable, you can bring your own styles and apply them however you want: [Tailwind CSS](https://tailwindcss.com/), CSS-in-JS, vanilla CSS via inline styles, classes, or by targeting the `[frimousse-*]` attributes present on each part. | ||
|
|
||
| You might want to use it in a popover rather than on its own. Frimousse only provides the emoji picker itself so if you don’t have a popover component in your app yet, there are several libraries available: [Radix UI](https://www.radix-ui.com/primitives/docs/components/popover), [Base UI](https://base-ui.com/react/components/popover), [Headless UI](https://headlessui.com/react/popover), and [React Aria](https://react-spectrum.adobe.com/react-aria/Popover.html), to name a few. | ||
|
|
||
| ### shadcn/ui | ||
|
|
||
| If you are using [shadcn/ui](https://ui.shadcn.com/), you can install a pre-built version which integrates with the existing shadcn/ui variables via the [shadcn CLI](https://ui.shadcn.com/docs/cli). | ||
|
|
||
| ```bash | ||
| npx shadcn@latest add https://frimousse.liveblocks.io/r/emoji-picker | ||
| ``` | ||
|
|
||
| It can be composed and combined with other shadcn/ui components like [Popover](https://ui.shadcn.com/docs/components/popover). | ||
|
|
||
| ## Documentation | ||
|
|
||
| Find the full documentation and examples on [frimousse.liveblocks.io](https://frimousse.liveblocks.io). | ||
|
|
||
| ## Miscellaneous | ||
|
|
||
| The name [“frimousse”](https://en.wiktionary.org/wiki/frimousse) means “little face” in French, and it can also refer to smileys and emoticons. | ||
|
|
||
| The emoji picker component was originally created for the [Liveblocks Comments](https://liveblocks.io/comments) default components, within [`@liveblocks/react-ui`](https://github.com/liveblocks/liveblocks/tree/main/packages/liveblocks-react-ui). | ||
|
|
||
| ## Credits | ||
|
|
||
| The emoji data is based on [Emojibase](https://emojibase.dev/). | ||
This file contains hidden or 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 hidden or 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,2 @@ | ||
| User-agent: * | ||
| Allow: / |
This file contains hidden or 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,14 @@ | ||
| import type { MetadataRoute } from "next"; | ||
| import { config } from "@/config"; | ||
|
|
||
| export default async function sitemap(): Promise<MetadataRoute.Sitemap> { | ||
| "use cache"; | ||
| return [ | ||
| { | ||
| url: config.url, | ||
| lastModified: new Date(), | ||
| changeFrequency: "monthly", | ||
| priority: 1, | ||
| }, | ||
| ]; | ||
| } |
This file contains hidden or 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,10 @@ | ||||||
| export const config = { | ||||||
| name: "Frimousse — An emoji picker for React", | ||||||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
We could potentially do this so it matches liveblocks.io. |
||||||
| url: "https://frimousse.liveblocks.io", | ||||||
| description: | ||||||
| "Frimousse is an open-source, lightweight, unstyled, and composable emoji picker for React—originally created for Liveblocks Comments. Styles can be applied with CSS, Tailwind CSS, CSS-in-JS, and more.", | ||||||
| links: { | ||||||
| twitter: "https://x.com/liveblocks", | ||||||
| github: "https://github.com/liveblocks/frimousse", | ||||||
| }, | ||||||
| } as const; | ||||||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is counter-intuitive to have since it doesn't have the full docs, reading through the page's HTML might be "harder" but if this version gets picked up over the page then it will miss 90% of the docs.I misunderstood the purporse of
llms.txtand viewed it as an alternative rather than a summary, we can keep it 👍