pickles2/lib-px2-theme-editor

0.2.12 2024-09-10 11:44 UTC

README

Usage

Server Side (PHP)

<?php
/**
 * api.php
 */
require_once('vendor/autoload.php');

$px2te = new pickles2\libs\themeEditor\main( $px );
$px2te->init(array(
	'appMode' => 'web', // 'web' or 'desktop'. default to 'web'
	'entryScript' => '/realpath/to/.px_execute.php', // Pickles 2 のエンドポイント
	'commands' => array(
		// コマンドのパスを指定する (任意)
		'php' => array(
			'bin' => 'php',
			'ini' => null,
		),
	),
));

$value = $px2te->gpi( json_decode( $_REQUEST['data'] ) );
header('Content-type: text/json');
echo json_encode($value);
exit;

Client Side

<div id="canvas"></div>

<!--
エディタが利用する CSSJavaScript などのリソースファイルがあります。
`$px2te->get_client_resources()` からリソースの一覧を取得し、読み込んでください。
-->

<?php
require_once('vendor/autoload.php');

$px2te = new pickles2\libs\themeEditor\main( $px );
$px2te->init( /* any options */ );

$resources = $px2te->get_client_resources();
foreach($resources->css as $css_file){
	echo('<link rel="stylesheet" href="'.htmlspecialchars($css_file).'" />');
}
foreach($resources->js as $js_file){
	echo('<script src="'.htmlspecialchars($js_file).'"></script>');
}
?>

<script>
var pickles2ThemeEditor = new Pickles2ThemeEditor();
pickles2ThemeEditor.init(
	{
		'elmCanvas': document.getElementById('canvas'), // <- 編集画面を描画するための器となる要素
		'lang': 'en', // language
		'gpiBridge': function(input, callback){
			// GPI(General Purpose Interface) Bridge
			// broccoliは、バックグラウンドで様々なデータ通信を行います。
			// GPIは、これらのデータ通信を行うための汎用的なAPIです。
			$.ajax({
				"url": '/your/api/path',
				"type": 'post',
				'data': {'data':JSON.stringify(input)},
				"success": function(data){
					callback(data);
				}
			});
			return;
		},
        'themeLayoutEditor': function(themeId, layoutId){
            alert('themeLayoutEditor: '+themeId+'/'+layoutId);
        },
        'openInBrowser': function(path){
            alert('openInBrowser: '+path);
        },
        'openInFinder': function(path){
            alert('openInFinder: '+path);
        },
        'openInTextEditor': function(path){
            alert('openInTextEditor: '+path);
        }
	},
	function(){
		// スタンバイ完了したら呼び出されるコールバックメソッドです。
		console.info('standby!!');
	}
);
</script>

更新履歴 - Change log

pickles2/lib-px2-theme-editor v0.2.12 (2024年9月10日)

  • モジュールを更新した。

pickles2/lib-px2-theme-editor v0.2.11 (2024年4月30日)

  • "2023 Pickles 2" テンプレート, "2023 Pickles 2 Darkmode" テンプレート
    • スタイルに関する微調整。
  • その他、いくつかの細かい修正。

pickles2/lib-px2-theme-editor v0.2.10 (2024年2月18日)

  • "2023 Pickles 2" テンプレート, "2023 Pickles 2 Darkmode" テンプレート
    • サイドバーが画面内に固定されるようになった。
    • スタイルに関する微調整。
  • スタートアップ機能で、テーマテンプレートごとの異なるオプションに対応した。
  • ブロックエディタで作成された新規レイアウトの編集が開始できない不具合を修正。

pickles2/lib-px2-theme-editor v0.2.9 (2023年11月13日)

  • "2023 Pickles 2" テンプレートのスタイル調整を追加した。
  • "2023 Pickles 2" テンプレートで、 article レイアウトにロゴ画像が適用されない不具合を修正した。
  • 多言語対応に関する更新。
  • サブプロジェクトで プレビュー したとき、$conf->path_controot を考慮した画面を開くようになった。
  • テンプレート Pickles 2 Darkmode 2023 の改善。
  • ダークモード用のスタイルをバンドルした。

pickles2/lib-px2-theme-editor v0.2.8 (2023年9月24日)

  • 編集方法の変更ダイアログで、現在の編集方法がプリセットされない不具合を修正した。

pickles2/lib-px2-theme-editor v0.2.7 (2023年8月29日)

  • article レイアウトを標準化した。
  • ダークモードテンプレートのスタイリングを修正。

pickles2/lib-px2-theme-editor v0.2.6 (2023年5月1日)

  • "2023 Pickles 2" テンプレートに、コンテンツモジュールのスタイル調整を追加した。
  • "2023 Pickles 2 Darkmode" テンプレートを追加した。
  • "SHIROMUKU" テンプレートを追加した。
  • テーマアイコンの表示を廃止した。
  • クライアントサイドにオプション openInBrowser を追加。
  • テンプレートが キャッチコピー($conf->tagline) に対応した。

pickles2/lib-px2-theme-editor v0.2.5 (2023年3月11日)

  • テーマテンプレートのユーザビリティを向上と不具合の修正。
  • ハンバーガーメニューモジュールを追加。
  • バナーモジュールを追加。

pickles2/lib-px2-theme-editor v0.2.4 (2023年2月11日)

  • スタートアップ機能での初期化時に、 Broccoli コンテンツのリビルドを実行するようになった。

pickles2/lib-px2-theme-editor v0.2.3 (2022年12月29日)

  • openInFinderopenInTextEditor を省略できるようになった。

pickles2/lib-px2-theme-editor v0.2.2 (2022年11月3日)

  • テーマテンプレートの微修正。

pickles2/lib-px2-theme-editor v0.2.1 (2022年6月5日)

  • 依存パッケージのバージョンを更新。

pickles2/lib-px2-theme-editor v0.2.0 (2022年1月8日)

  • サポートするPHPのバージョンを >=7.3.0 に変更。
  • PHP 8.1 に対応した。

pickles2/lib-px2-theme-editor v0.1.1 (2022年1月3日)

  • レイアウトの編集方法変更ができるようになった。
  • パフォーマンスに関する改善。
  • サーバーサイドの初期化オプション commands を追加。
  • 内部コードの改善。

pickles2/lib-px2-theme-editor v0.1.0 (2021年6月26日)

  • テーマのスタートアップ機能を追加。

pickles2/lib-px2-theme-editor v0.0.2 (2021年2月21日)

  • Windows で プラグインオプションの取得と、デフォルトテーマの変更に失敗する問題を修正。
  • レイアウトとスタイリングの修正。
  • ダークモードへの対応。
  • その他の細かい不具合の修正。

pickles2/lib-px2-theme-editor v0.0.1 (2020年12月30日)

  • 初回リリース

License

MIT License

Author