パッケージ、リポジトリ、アプリカテゴリを検索

syntax_highlight のカバー
パッケージ詳細v0.5.0

syntax_highlight

Flutter用のVSCodeスタイルの構文ハイライトで、文字列を受け取り、フォーマットされたTextSpanを返します。

AndroidiOSWebmacOSWindowsLinux
30日間ダウンロード
2.7万
いいね数
79
Pub ポイント
150

パッケージをインストール

flutter pub add syntax_highlight

パッケージ概要

公開情報に基づく選定ガイドです。参考としてご利用ください。

コードスニペット用にVSCodeスタイルの構文強調を提供するFlutter/Dartパッケージです。プレーンテキスト文字列を受け取り、キーワード、文字列、コメント、その他の言語要素に適切な色を付けてフォーマットされたTextSpanに変換します。アプリ、ドキュメント、開発ツールでコードを表示するのに最適です。Android、iOS、Web、macOS、Windows、Linuxなど複数のプラットフォームをサポートしており、デバイス間で一貫したレンダリングを実現します。軽量で、既存のFlutterプロジェクトへの統合もスムーズです。

用途

  • ドキュメントアプリケーションでコードスニペットを表示する
  • IDE風のアプリケーションにおけるコードエディターウィジェットの強化
  • 学習またはチュートリアルプラットフォームでソースコードを強調表示する
  • 開発者ツールにおける構文認識テキストレンダリングの統合
  • リアルタイム共同作業アプリでのコードの可視化

主な機能

  • VSCode を意識したカラースキーム
  • 複数のプログラミング言語をサポートしています
  • 簡単な統合のための TextSpan を返します
  • 軽量でパフォーマンスに優れる
  • クロスプラットフォーム互換性
  • カスタマイズ可能なテーマとスタイル

適している対象

  • Flutter開発者がコードエディタを構築しています
  • コード例付きの教育アプリ
  • 開発者ツールおよびIDE拡張機能
  • ドキュメンテーションおよびチュートリアルプラットフォーム
  • リアルタイムコード共有またはコラボレーションアプリ

注意事項

  • 手動での言語検出または指定が必要です
  • 基本的な構文ルールに限定(高度な解析なし)
  • 標準外の言語用にカスタマイズが必要になる場合があります
  • パフォーマンスは入力サイズに依存します
  • 実行時における動的言語切り替えをサポートしていません

元の README

関連するソースリポジトリの README 原文のスナップショットです。最新の内容はリポジトリをご覧ください。

Flutter Syntax Highlight

Syntax Highlight

The Syntax Highlight package uses the TextMate rules for highlighting code, which is used by many popular applications such as VSCode. It is easy to extend the language support by dropping in new grammar files in the grammars directory.

Currently supported languages are: css, dart, go, html, java, javascript, json, kotlin, python, rust, serverpod_protocol, sql, swift, typescript, and yaml.

Code editor

The Syntax Highlight package also comes bundled with a CodeEditor widget, which provides a simplistic interface for editing code. It supports rich text copy (e.g., for pasting into Google Slides).

Live Demo

Usage

Before you can use the Highlighter class it needs to be initialized. The initialization will load the requested grammar files and parse them.

// Initialize the highlighter.
await Highlighter.initialize(['dart', 'yaml', 'sql']);

Next load a theme and create a highlighter.

// Load the default light theme and create a highlighter.
var theme = await HighlighterTheme.loadLightTheme();
var highlighter = Highlighter(
  language: 'dart',
  theme: theme,
);

Now, you can highlight your code by calling the highlight method. The highlight method will return a TextSpan, which you can use in a Text widget.

Widget build(BuildContext context) {
  var highlightedCode = highlighter.highlight(myCodeString);
  return Text.rich(highlightedCode);
}

An example of highlighted code: Highlighted code

カテゴリー

依存関係

依存関係一覧 3 件

ソースリポジトリ

このパッケージを使用しているプロジェクト