1 В избранное 0 Ответвления 0

OSCHINA-MIRROR/uiw-react-markdown-editor

Присоединиться к Gitlife
Откройте для себя и примите участие в публичных проектах с открытым исходным кодом с участием более 10 миллионов разработчиков. Приватные репозитории также полностью бесплатны :)
Присоединиться бесплатно
Это зеркальный репозиторий, синхронизируется ежедневно с исходного репозитория.
Клонировать/Скачать
Внести вклад в разработку кода
Синхронизировать код
Отмена
Подсказка: Поскольку Git не поддерживает пустые директории, создание директории приведёт к созданию пустого файла .keep.
Loading...
README.md

Текст запроса:

react-markdown-editor logo

Build & Deploy NPM Download npm version

A markdown editor with preview, implemented with React.js and TypeScript.

Install

npm i @uiw/react-markdown-editor

Document

Official document demo preview (🇨🇳中国镜像网站)

Basic Usage

import MarkdownEditor from '@uiw/react-markdown-editor';
import React from 'react';
import ReactDOM from 'react-dom';

const Dome = () => (
  <MarkdownEditor
    value={this.state.markdown}
    onChange={this.updateMarkdown}
  />
);

ReactDOM.render(<Dome />, document.getElementById('app'));

Controlled Usage

Open in CodeSandbox

import MarkdownEditor from '@uiw/react-markdown-editor';
import React, { useState } from 'react';
import ReactDOM from 'react-dom';

function App() {
  const [markdown, setMarkdown] = useState("");
  return (
    <MarkdownEditor
      value="# This is a H1  \n## This is a H2  \n###### This язык текста запроса  английский.

Перевод:

**Текст запроса:**

<p align="center">
  <a href="https://github.com/uiwjs/react-markdown-editor">
    <img alt="react-markdown-editor logo" src="./website/logo.svg?sanitize=true">
  </a>
</p>

<!--dividing-->

<p align="center">
  <a href="https://github.com/uiwjs/react-markdown-editor/actions">
    <img alt="Build & Deploy" src="https://github.com/uiwjs/react-markdown-editor/actions/workflows/ci.yml/badge.svg">
  </a>
  <a href="https://www.npmjs.com/package/@uiw/react-markdown-editor">
    <img alt="NPM Download" src="https://img.shields.io/npm/dm/@uiw/react-markdown-editor.svg?style=flat">
  </a>
  <a href="https://www.npmjs.com/package/@uiw/react-markdown-editor">
    <img alt="npm version" src="https://img.shields.io/npm/v/@uiw/react-markdown-editor.svg">
  </a>
</p>

<p align="center">A markdown editor with preview, implemented with React.js and TypeScript.</p>

## Install

```bash
npm i @uiw/react-markdown-editor

Document

Official document demo preview (🇨🇳中国镜像网站)

Basic Usage

import MarkdownEditor from '@uiw/react-markdown-editor';
import React from 'react';
import ReactDOM from 'react-dom';

const Dome = () => (
  <MarkdownEditor
    value={this.state.markdown}
    onChange={this.updateMarkdown}
  />
);

ReactDOM.render(<Dome />, document.getElementById('app'));

Controlled Usage

Open in CodeSandbox

import MarkdownEditor from '@uiw/react-markdown-editor';
import React, { useState } from 'react';
import ReactDOM from 'react-dom';

function App() {
  const [markdown, setMarkdown] = useState("");
  return (
    <MarkdownEditor
      value="# This is a H1  \n## This is a H2  \n######

Как видно из перевода, текст запроса написан на английском языке. ## Поддержка тёмного режима (dark-mode/night-mode)

По умолчанию тёмный режим (`dark-mode`) автоматически переключается в соответствии с системой. Если вам нужно переключиться вручную, просто установите параметр `data-color-mode="dark"` для элемента html.

```html
<html data-color-mode="dark">
document.documentElement.setAttribute('data-color-mode', 'dark')
document.documentElement.setAttribute('data-color-mode', 'light')

Наследуйте пользовательские цветовые переменные, добавив селектор .wmde-markdown-var.

const Demo = () => {
  return (
    <div>
      <div className="wmde-markdown-var"> </div>
      <MarkdownEditor value="Hello Markdown!" />
    </div>
  )
}

Props

  • value (string) — необработанная уценка, которая будет преобразована в HTML (обязательно);
  • visible? : boolean — показывает превью, которое будет преобразовано в HTML;
  • toolbars? : ICommand[] | string[] — настройки отображения инструментов;
  • toolbarsMode? : ICommand[] | string[] — настройки отображения инструментов;
  • onChange? : function(editor: IInstance, data: CodeMirror.EditorChange, value: string) — вызывается при внесении изменений;
  • onBlur? : function(editor: IInstance, event: Event) — событие происходит, когда объект теряет фокус;
  • previewPropsреквизиты react-markdown.

Другие варианты реквизита

Разработка

npm run dev
npm run type-check:watch
npm run doc

Связанное

  • @uiw/react-textarea-code-editor: простой редактор кода с подсветкой синтаксиса.
  • @uiw/react-codemirror: компонент CodeMirror для React. @codemirror
  • @uiw/react-monacoeditor: компонент Monaco Editor для React.
  • @uiw/react-md-editor: простой редактор уценки с предварительным просмотром, реализованный с помощью React.js и TypeScript.
  • @uiw/react-markdown-preview: компонент React для предварительного просмотра текста уценки в веб-браузере.

Участники

Как всегда, спасибо нашим замечательным участникам!

Сделано с github-action-contributors.

Лицензия

Лицензия MIT.

Комментарии ( 0 )

Вы можете оставить комментарий после Вход в систему

Введение

Компонент редактора Markdown на основе React. Развернуть Свернуть
MIT
Отмена

Обновления (1)

все

Участники

все

Недавние действия

Загрузить больше
Больше нет результатов для загрузки
1
https://gitlife.ru/oschina-mirror/uiw-react-markdown-editor.git
git@gitlife.ru:oschina-mirror/uiw-react-markdown-editor.git
oschina-mirror
uiw-react-markdown-editor
uiw-react-markdown-editor
master