React と SandPack を使用したオールインワン コード エディターの作成

この記事では、CodeSandbox による人気のプレイグラウンド フレームワークである SandPack について調査し、それを使用してユーザーにとってより動的でインタラクティブな環境を作成する方法について説明します。

この記事では、SandPack について知っておくべき基本的な事項のほぼすべてを説明します。ただし、フックやカスタム コンポーネントなどのより高度な機能やクールなカスタマイズ オプションについては、私のブログで詳しく説明しています。

この記事の詳細版を確認してください

サンドパックとは

SandPack は、ブログや技術ドキュメント用のライブ コード エディターを構築するためのコンポーネント ツールキットです。この記事では、軽量の JavaScript バンドラーである Sandpack-client ではなく、sandpack-react に焦点を当てます。

SandPack を際立たせているのは、利用可能な幅広いカスタマイズ オプションです。さらに、始めるのはとても簡単です。 Sandpack-react の最も便利な機能は次のとおりです:

• 一般的な言語とフレームワーク用の事前に構築されたテンプレート
• エディター用の多数の事前構築済みテーマと、カスタム テーマを作成するオプション。
• すべての npm 依存関係と主要な JavaScript フレームワークのサポート。
• UI とプレイグラウンドのほぼすべての側面をカスタマイズするオプション。
• 事前構築されたコンポーザブル コンポーネントを使用して、完全にカスタムのプレイグラウンドを作成できます。
• プロバイダーとカスタム フックを使用してカスタム コンポーネントを作成できます。

ザ プレイグラウンドの概要

sandpack-react を開始するには、次の npm または Yarn コマンドを実行します。

npm i @codesandbox/sandpack-react

または
糸追加 @codesandbox/sandpack-react

次に、Sandpack プレイグラウンドをインポートし、次のコードを使用してレンダリングします。

import { Sandpack } from "@codesandbox/sandpack-react";

export default function App() {
  return <Sandpack />
}

<サンドパック />コンポーネントは、すぐに参加できる空のプレイグラウンドを設定します。デフォルトでは、プレイグラウンドには基本的な React テンプレートが含まれています。テンプレートやテーマなどをカスタマイズするための基本的な小道具を見てみましょう:

• template: このプロパティは、テンプレートの事前定義されたリストを受け入れます。デフォルトではバニラが設定されています。
• files: これは非常に便利なプロパティです。通常のフォルダー構造と同様に、カスタム コードを使用して複数のファイルを作成できます。ファイル オブジェクトには、値 (相対ファイル パス) とキー (ファイルの内容) が含まれます。このオブジェクト内のファイルはタブにも自動的に表示されます。
• options: options オブジェクトを使用して、いくつかの機能をカスタマイズできます。完全なリストはここでご覧いただけます。最も役立つものには次のようなものがあります。
  • showLineNumbers: 行番号の表示を切り替えます。
  • showTabs: タブの表示/非表示を切り替えます。
  • クラス: 既存のテンプレート クラスにカスタム クラス名を割り当てて、さらにカスタマイズできます。
• 依存関係: 依存関係オブジェクトには、アプリに必要な任意の NPM パッケージを含めることができます。形式と構文は package.json ファイルの形式と構文に似ています。
• テーマ: 事前に構築されたテーマを選択するか、完全にカスタムのテーマを割り当てることができます。

PlayGround のカスタマイズ

私たちのスタイルに合うようにデフォルトのプレイグラウンドを微調整し、試してみる楽しいサンプルを作成しましょう。サイトのテーマに合わせてエディターをカスタマイズすると、エディターがシームレスに溶け込み、サードパーティ製の埋め込みのように感じられなくなります。まず、files プロップを使用して、単純なカウンター ボタンを作成しましょう。 App.js ファイルの他に、App.css ファイルも作成します。

以下の例とコードを見てください:

この例では、カウンター コンポーネントがプレイグラウンドにレンダリングされます。ファイル オブジェクトには、App.js と App.css の両方のコードが含まれています。前述の事前構築済みリストからテーマを選択し、サンドパック テーマをソースとして、スタイルを加えています。行番号も true に設定されています。

さらに、遊び場のレイアウトを簡単にカスタマイズできます。これは、カスタム クラスを適用するか、SandPack が提供する事前構築されたオプションを利用することで実行できます。たとえば、次のようなカスタム クラスを使用できます:

<Sandpack
  theme={theme}
  template="react"
  options={{
    classes: {
      "sp-wrapper": "custom-wrapper",
      "sp-layout": "custom-layout",
      "sp-tab-button": "custom-tab",
    },
  }}
/>

その後、CSS を使用して外観とレイアウトを調整し、視覚的なデザインをさらに細かく制御できるようになります。

Another useful feature is the ability to switch between different layout modes. SandPack offers three modes: preview, tests, and console. The default mode is preview, while the tests mode provides a suite for running tests and the console mode renders a terminal/console component instead of a preview window. The console mode is useful for displaying outputs of server side logic. You can also switch the layout direction using the rtl (Right to left layout) option.

Customizing the Output

Besides the editor itself, the output display can be customized as well. For instance, you can choose to show or hide the console, change the layout, or even modify the appearance of the preview window. Pretty cool right!. Code editors often have heavily customized editing windows, but the actual output is not paid attention to as much.

The console displays all sorts of errors and console logs. Depending on the type of code snippet being showcased, you'd either want to show or hide the console. You can also toggle the visibility of the show console button. By default, the console is hidden. As with all the SandPack components, the styling can be individually modified using custom CSS classes.

<Sandpack
  template="react"
  files={files}
  theme={nightOwl}
  options={{
    showConsole: true,
    showConsoleButton: true,
  }}
/>;

Besides the console, the display window itself can be customized as well. For example, you can turn the navigator bar on or off with the showNavigator option and decide if you want the panels to be resizable with the resizablePanels option.

<Sandpack
  template="react"
  files={files}
  theme={nightOwl}
  options={{
    showLineNumbers: true,
    showNavigator: true,
    resizablePanels: true,
  }}
/>

The result will look somewhat like this:

Conclusion

Sandpack isn't just easy to use—it's also super customizable. This makes it a great choice for blogs, documentation, or any platform where live code editing adds value, while still allowing developers to customize it based on their sites.

You can check the detailed version of this article here
Thanks for reading!

以上がReact と SandPack を使用したオールインワン コード エディターの作成の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。