Skip to content
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

[Lexical] Create initial Gallery View with Emoji Plugin Example #44

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 5 additions & 26 deletions packages/lexical-website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -239,24 +239,6 @@ const config = {
onBrokenMarkdownLinks: 'throw',
organizationName: 'facebook',
plugins: [
process.env.FB_INTERNAL
? null
: [
'./plugins/package-docs',
/** @type {import('./plugins/package-docs').PackageDocsPluginOptions} */
{
baseDir: path.resolve(__dirname, '..'),
editUrl: `${GITHUB_REPO_URL}/tree/main/packages/`,
packageFrontMatter: {
lexical: [
'sidebar_position: 1',
'sidebar_label: lexical (core)',
].join('\n'),
},
targetDir: path.resolve(__dirname, 'docs/packages'),
},
],
'./plugins/webpack-buffer',
['docusaurus-plugin-typedoc', docusaurusPluginTypedocConfig],
async function tailwindcss() {
return {
Expand All @@ -281,7 +263,6 @@ const config = {
docs: {
beforeDefaultRemarkPlugins: [slugifyPlugin],
editUrl: `${GITHUB_REPO_URL}/tree/main/packages/lexical-website/`,
exclude: process.env.FB_INTERNAL ? ['docs/error/**'] : [],
path: 'docs',
sidebarItemsGenerator,
sidebarPath: require.resolve('./sidebars.js'),
Expand Down Expand Up @@ -405,13 +386,11 @@ const config = {
label: 'iOS',
position: 'left',
},
process.env.FB_INTERNAL
? {
label: 'Gallery',
position: 'left',
to: '/gallery',
}
: null,
{
label: 'Gallery',
position: 'left',
to: '/gallery',
},
{
href: GITHUB_REPO_URL,
label: 'GitHub',
Expand Down
4 changes: 4 additions & 0 deletions packages/lexical-website/fb/sdoc-cache.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
{
"snippets": {},
"description": "@generated"
}
48 changes: 48 additions & 0 deletions packages/lexical-website/src/components/Gallery/Card.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import Link from '@docusaurus/Link';
import Heading from '@theme/Heading';
import clsx from 'clsx';
import React from 'react';

import styles from './styles.module.css';

function getCardImage(item) {
return (
item.preview ??
`https://slorber-api-screenshot.netlify.app/${encodeURIComponent(
item.uri,
)}/showcase`
);
}

function Card({item}) {
const image = getCardImage(item);
return (
<li key={item.title} className="card shadow--md">
<a href={item.uri} target="_blank">
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

The anchor tag that opens the link in a new tab is missing the 'rel="noopener noreferrer"' attribute. When using 'target="_blank"', it's important to include this attribute to prevent potential security vulnerabilities. Please update the anchor tag to include this attribute.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add rel="noopener noreferrer" to the anchor tag.

When using target="_blank", include rel="noopener noreferrer" to prevent potential security vulnerabilities.

<a href={item.uri} target="_blank" rel="noopener noreferrer">

<div className={clsx('card__image', styles.showcaseCardImage)}>
<img src={image} alt={item.title} />
</div>
</a>
<div className="card__body">
<div className={clsx(styles.showcaseCardHeader)}>
<Heading as="h4" className={styles.showcaseCardTitle}>
<Link href={item.website} className={styles.showcaseCardLink}>
{item.title}
</Link>
</Heading>
</div>
<p className={styles.showcaseCardBody}>{item.description}</p>
</div>
</li>
);
}
Comment on lines +25 to +46
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

I noticed that the Card component doesn't handle potential missing data in the 'item' prop. This could lead to runtime errors if any of the expected properties (title, uri, website, description) are undefined or null. Consider adding null checks or default values to ensure the component renders gracefully even with incomplete data. For example, you could use the optional chaining operator (?.) or provide fallback values using the nullish coalescing operator (??).

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Comment on lines +25 to +46
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Handle potential missing data in the item prop.

The Card component should handle cases where properties like title, uri, website, or description might be undefined or null. Consider using optional chaining or default values.

function Card({item}) {
  const image = getCardImage(item);
  return (
    <li key={item.title ?? 'default-title'} className="card shadow--md">
      <a href={item.uri ?? '#'} target="_blank" rel="noopener noreferrer">
        <div className={clsx('card__image', styles.showcaseCardImage)}>
          <img src={image} alt={item.title ?? 'No title'} />
        </div>
      </a>
      <div className="card__body">
        <div className={clsx(styles.showcaseCardHeader)}>
          <Heading as="h4" className={styles.showcaseCardTitle}>
            <Link href={item.website ?? '#'} className={styles.showcaseCardLink}>
              {item.title ?? 'No title'}
            </Link>
          </Heading>
        </div>
        <p className={styles.showcaseCardBody}>{item.description ?? 'No description available.'}</p>
      </div>
    </li>
  );
}


export default React.memo(Card);
38 changes: 38 additions & 0 deletions packages/lexical-website/src/components/Gallery/GalleryCards.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
import clsx from 'clsx';

import Card from './Card';
import {plugins} from './pluginList';
import styles from './styles.module.css';

function CardList({cards}) {
return (
<div className="container">
<ul className={clsx('clean-list', styles.cardList)}>
{cards.map((item) => (
<Card key={item.title} item={item} />
))}
Comment on lines +20 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

In the CardList component, you're currently using the 'title' property as the key for each Card component. While this might work if all titles are unique, it's generally safer to use a dedicated unique identifier. Consider modifying the data structure in 'pluginList.js' to include a unique 'id' for each item, and then use this 'id' as the key. For example:

{cards.map((item) => (
  <Card key={item.id} item={item} />
))}

This change will ensure that React can efficiently update the list of cards, even if titles are not unique or if they change.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Comment on lines +20 to +22
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Use a unique identifier for the Card key.

Using title as a key may not be unique. Consider modifying the data structure in pluginList.js to include a unique id for each item and use this id as the key.

{cards.map((item) => (
  <Card key={item.id} item={item} />
))}

</ul>
</div>
);
}
Comment on lines +16 to +26
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

In the CardList component, it's important to add error handling for the 'cards' prop. Currently, if 'cards' is undefined or not an array, the component will throw an error when trying to map over it. Consider adding a check to ensure 'cards' is defined and is an array before rendering. For example:

function CardList({cards}) {
  if (!Array.isArray(cards)) {
    return <div>No cards to display</div>;
  }
  return (
    <div className="container">
      <ul className={clsx('clean-list', styles.cardList)}>
        {cards.map((item) => (
          <Card key={item.title} item={item} />
        ))}
      </ul>
    </div>
  );
}

This change will improve the robustness of the component and prevent potential runtime errors.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Comment on lines +16 to +26
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add error handling for the cards prop.

The CardList component should check if cards is defined and is an array before rendering to prevent potential runtime errors.

function CardList({cards}) {
  if (!Array.isArray(cards)) {
    return <div>No cards to display</div>;
  }
  return (
    <div className="container">
      <ul className={clsx('clean-list', styles.cardList)}>
        {cards.map((item) => (
          <Card key={item.title} item={item} />
        ))}
      </ul>
    </div>
  );
}


export default function GalleryCards() {
const {
siteConfig: {customFields},
} = useDocusaurusContext();

return (
<section className="margin-top--lg margin-bottom--xl">
<CardList cards={plugins(customFields)} />
</section>
);
}
17 changes: 17 additions & 0 deletions packages/lexical-website/src/components/Gallery/GalleryPage.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

import GalleryCards from './GalleryCards';

export default function GalleryPage() {
return (
<main className="margin-vert--lg">
<GalleryCards />
</main>
);
}
14 changes: 14 additions & 0 deletions packages/lexical-website/src/components/Gallery/pluginList.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/**
* Copyright (c) Meta Platforms, Inc. and affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*
*/

export const plugins = (customFields) => [
{
title: 'EmojiPlugin',
uri: `${customFields.STACKBLITZ_PREFIX}examples/vanilla-js-plugin?embed=1&file=src%2Femoji-plugin%2FEmojiPlugin.ts&terminalHeight=0&ctl=1`,
},
];
Comment on lines +9 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

category Functionality

The plugins function relies on customFields.STACKBLITZ_PREFIX, but there's no check to ensure customFields or STACKBLITZ_PREFIX are defined. This could lead to runtime errors if the function is called without the expected parameter or if STACKBLITZ_PREFIX is missing. Consider adding a default value or a check to handle cases where these might be undefined. For example:

export const plugins = (customFields = {}) => [
  {
    title: 'EmojiPlugin',
    uri: `${customFields.STACKBLITZ_PREFIX || ''}examples/vanilla-js-plugin?embed=1&file=src%2Femoji-plugin%2FEmojiPlugin.ts&terminalHeight=0&ctl=1`,
  },
];

This change would prevent potential runtime errors and make the function more robust.

Chat with Korbit by mentioning @korbit-ai, and give a 👍 or 👎 to help Korbit improve your reviews.

Comment on lines +9 to +14
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add error handling for customFields.

The plugins function relies on customFields.STACKBLITZ_PREFIX, which could lead to runtime errors if customFields or STACKBLITZ_PREFIX are undefined. Consider adding a default value or a check to handle these cases.

export const plugins = (customFields = {}) => [
  {
    title: 'EmojiPlugin',
    uri: `${customFields.STACKBLITZ_PREFIX || ''}examples/vanilla-js-plugin?embed=1&file=src%2Femoji-plugin%2FEmojiPlugin.ts&terminalHeight=0&ctl=1`,
  },
];

68 changes: 68 additions & 0 deletions packages/lexical-website/src/components/Gallery/styles.module.css
Original file line number Diff line number Diff line change
@@ -0,0 +1,68 @@
/**
* Copyright (c) Facebook, Inc. and its affiliates.
*
* This source code is licensed under the MIT license found in the
* LICENSE file in the root directory of this source tree.
*/

.cardList {
display: grid;
grid-template-columns: repeat(auto-fill, minmax(280px, 1fr));
gap: 24px;
}

.showcaseFavorite {
padding-top: 2rem;
padding-bottom: 2rem;
background-color: #f6fdfd;
}

html[data-theme='dark'] .showcaseFavorite {
background-color: #232525;
}

.headingFavorites {
display: flex;
align-items: center;
}

.showcaseCardImage {
overflow: hidden;
height: 150px;
border-bottom: 2px solid var(--ifm-color-emphasis-200);
}

.showcaseCardHeader {
display: flex;
align-items: center;
margin-bottom: 12px;
}

.showcaseCardTitle {
margin-bottom: 0;
flex: 1 1 auto;
}

.showcaseCardTitle a {
text-decoration: none;
background: linear-gradient(
var(--ifm-color-primary),
var(--ifm-color-primary)
)
0% 100% / 0% 1px no-repeat;
transition: background-size ease-out 200ms;
}

.showcaseCardTitle a:not(:focus):hover {
background-size: 100% 1px;
}

.showcaseCardTitle,
.showcaseCardHeader {
margin-right: 0.25rem;
}

.showcaseCardBody {
font-size: smaller;
line-height: 1.66;
}
29 changes: 0 additions & 29 deletions packages/lexical-website/src/components/GalleryPage.js

This file was deleted.

4 changes: 2 additions & 2 deletions packages/lexical-website/src/pages/gallery.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ id: gallery
title: Gallery
---
import { FBInternOnly } from 'docusaurus-plugin-internaldocs-fb/internal';
import GalleryPage from '@site/src/components/GalleryPage';
import GalleryPage from '@site/src/components/Gallery/GalleryPage';

# Gallery (WIP)
# Gallery
<GalleryPage/>