Skip to content
This repository has been archived by the owner on Jul 31, 2024. It is now read-only.

flow-md-editor 1.0.0

Install from the command line:
Learn more about npm packages
$ npm install @ollionorg/flow-md-editor@1.0.0
Install via package.json:
"@ollionorg/flow-md-editor": "1.0.0"

About this version

Flow MD Editor

The Flow md editor is built on the Flow design framework (website / github) using Monaco Editor

Installation

1️⃣ Install flow code editor dependency

yarn add @cldcvr/flow-md-editor

Note: after installation, re-start your application.


2️⃣ Import styles/CSS

For Vue JS: Paste the below snippet after the closing <template> tag in your App.vue file

<style>
 @import "@cldcvr/flow-md-editor/dist/style.css";
</style> 
For React

React: Paste the below snippet in src/index.tsx or index.jsx file

import "@cldcvr/flow-md-editor/dist/style.css";
For Angular

Angular: Add css file path in angular.json in styles property array.

"styles": ["@cldcvr/flow-md-editor/dist/style.css"],

3️⃣ Import flow-md-editor into your project

Paste the below snippet in your project and add your application startup/runtime code to it.

Note: This is required to register Flow elements error-free. We achieve this by importing all flow packages asynchronously and then starting up your application.

For Vue JS: Paste the below snippet in your project, for src/main.ts or main.js

import("@cldcvr/flow-core").then(async () => {
	await import('@cldcvr/flow-md-editor');
	//add your application startup/runtime code here **
});
For React

Paste the below snippet in your project, for src/main.ts

import("@cldcvr/flow-core").then(async () => {
	await import("@cldcvr/flow-md-editor");
	//add your application startup/runtime code here **
});
For Angular

Paste the below snippet in your project, for src/index.tsx or index.jsx


4️⃣ For a typescript enabled project (optional)

Note: After adding, re-start your application. Make sure you are using version >4.5

For Vue 3: Copy paste below import types in your main.ts file.

import "@cldcvr/flow-md-editor/dist/types/vue3";
For Vue 2

Copy paste below import types in your main.ts file.

import "@cldcvr/flow-md-editor/dist/types/vue2";
For React

React: Include react type in tsconfig.json file like below.

"include": ["src", "./node_modules/@cldcvr/flow-md-editor/dist/types/react.ts"]

Details


Assets

  • flow-md-editor-1.0.0.tgz

Download activity

  • Total downloads 0
  • Last 30 days 0
  • Last week 0
  • Today 0