@leochen0204/grapesjs-mjml 1.0.7-fork-rc.0

package/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2017-current, Artur Arseniev
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification,
+are permitted provided that the following conditions are met:
+
+- Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+- Redistributions in binary form must reproduce the above copyright notice, this
+  list of conditions and the following disclaimer in the documentation and/or
+  other materials provided with the distribution.
+- Neither the name "GrapesJS" nor the names of its contributors may be
+  used to endorse or promote products derived from this software without
+  specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
+ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
+ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/README.md

@@ -0,0 +1,13 @@
+# GrapesJS MJML
+
+Forked from [GrapesJS/mjml](https://github.com/GrapesJS/mjml)
+
+## Installation
+
+```bash
+npm i @leochen0204/grapesjs-mjml
+```
+
+## License
+
+BSD 3-Clause

package/dist/index.d.ts

@@ -0,0 +1,141 @@
+import { Editor, Plugin } from 'grapesjs';
+import mjml from 'mjml-core';
+import { MJMLParsingOptions } from 'mjml-core';
+
+/**
+ * MJML Parser.
+ *
+ * @see {@link https://github.com/mjmlio/mjml/tree/master/packages/mjml-core}
+ */
+export type MjmlParser = typeof mjml;
+declare const componentsToQuery: (cmps: string | string[]) => string;
+export type ComponentPluginOptions = {
+	/**
+	 * Core model, which can be extended
+	 */
+	coreMjmlModel: any;
+	/**
+	 * Core view, which can be extended
+	 */
+	coreMjmlView: any;
+	opt: Required<PluginOptions>;
+	sandboxEl: HTMLDivElement;
+	componentsToQuery: typeof componentsToQuery;
+};
+export interface CommandOptionsMjmlToHtml extends MJMLParsingOptions {
+	mjml?: string;
+}
+export type PluginOptions = {
+	/**
+	 * Which blocks to add.
+	 * @default (all)
+	 */
+	blocks?: string[];
+	/**
+	 * Add custom block options, based on block id.
+	 * @default (blockId) => ({})
+	 * @example (blockId) => (blockId === 'mj-hero' ? { attributes: {...} } : {})
+	 */
+	block?: (blockId: string) => {};
+	/**
+	 * Code viewer theme.
+	 * @default 'hopscotch'
+	 */
+	codeViewerTheme?: string;
+	/**
+	 * Add custom MJML components
+	 *
+	 * @default []
+	 */
+	customComponents?: ((editor: Editor, componentOptions: ComponentPluginOptions) => void)[];
+	/**
+	 * Placeholder MJML template for the import modal
+	 * @default ''
+	 */
+	importPlaceholder?: string;
+	/**
+	 * Image placeholder source for mj-image block
+	 * @default ''
+	 */
+	imagePlaceholderSrc?: string;
+	/**
+	 * Custom MJML parser.
+	 * @default mjml-browser instance
+	 */
+	mjmlParser?: MjmlParser;
+	/**
+	 * Overwrite default export command
+	 * @default true
+	 */
+	overwriteExport?: boolean;
+	/**
+	 * String before the MJML in export code
+	 * @default ''
+	 */
+	preMjml?: string;
+	/**
+	 * String after the MJML in export code
+	 * @default ''
+	 */
+	postMjml?: string;
+	/**
+	 * Clean all previous blocks if true
+	 * @default true
+	 */
+	resetBlocks?: boolean;
+	/**
+	 * Reset the Style Manager and add new properties for MJML
+	 * @default true
+	 */
+	resetStyleManager?: boolean;
+	/**
+	 * Clean all previous devices and set a new one for mobile
+	 * @default true
+	 */
+	resetDevices?: boolean;
+	/**
+	 * Hide the default selector manager
+	 * @default true
+	 */
+	hideSelector?: boolean;
+	/**
+	 * Experimental: use XML parser instead of HTML.
+	 * This should allow importing void MJML elements (without closing tags) like <mj-image/>.
+	 * @default false
+	 * @experimental
+	 */
+	useXmlParser?: boolean;
+	/**
+	 * Column padding (this way it's easier to select columns)
+	 * @default '10px 0'
+	 */
+	columnsPadding?: string;
+	/**
+	 * I18n object containing languages, [more info](https://grapesjs.com/docs/modules/I18n.html#configuration).
+	 * @default {}
+	 */
+	i18n?: Record<string, any>;
+	/**
+	 * Custom fonts on exported HTML header, [more info](https://github.com/mjmlio/mjml#inside-nodejs).
+	 * @default {}
+	 * @example
+	 * {
+	 *   Montserrat: 'https://fonts.googleapis.com/css?family=Montserrat',
+	 *   'Open Sans': 'https://fonts.googleapis.com/css?family=Open+Sans'
+	 * }
+	 */
+	fonts?: Record<string, any>;
+	/**
+	 * Load custom preset theme.
+	 * @default true
+	 */
+	useCustomTheme?: boolean;
+};
+export type RequiredPluginOptions = Required<PluginOptions>;
+declare const plugin: Plugin<PluginOptions>;
+
+export {
+	plugin as default,
+};
+
+export {};