editorjs html Download - editorjs html Código fonte download

editorjs html

Outros recursos

Nested List Support

Baixar

editorjs-html

Uma utilidade para analisar os editores limpos de dados para html.

Use -o com JavaScript/Typatript simples, React, Angular, Vue ou qualquer motor/estrutura de modelos de sua escolha.
Rápido, eficiente e leve.
Totalmente personalizável para o núcleo.
Suporta blocos de editorjs básicos também personalizáveis.
Estenda -se para analisar seus próprios blocos.

O que é 'novo em v4?

Reescrita completa, dependências mais recentes com alterações mínimas da API.
As funções redundantes parseStrict() e validate() são removidas.
O modo rigoroso é configurável por meio de opções.
Erros de console se as funções do analisador para o bloco não forem avisas. O modo rigoroso lança erros.
O código é mais legível, modular. Isso facilitaria contribuir e rastrear alterações.
As definições de tipo são obtidas diretamente no editor.js, para que o desenvolvimento se torne mais fácil.
Teste de unidade com brincadeiras.

Instalação

Host self, versões pré -compiladas.

Navegador - get /.build/edjshtml.browser.js
Nodejs - get /.build/edjshtml.node.js
Para o navegador e o nó - get /.build/edjshtml.js

Npm

npm install editorjs-html

CDN

https://cdn.jsdelivr.net/npm/[email protected]/.build/edjshtml.js
(Build Build apenas): https://cdn.jsdelivr.net/npm/[email protected]/.build/edjshtml.browser.js

Uso

Navegador

  const edjsParser = edjsHTML ( ) ;
  let html = edjsParser . parse ( editorjs_clean_data ) ;
  console . log ( html ) ;

Nodejs

  const edjsHTML = require ( "editorjs-html" ) ;
  const edjsParser = edjsHTML ( ) ;
  const html = edjsParser . parse ( editorjs_clean_data ) ;

  console . log ( html ) ;

Atualizações

Veja lançamentos

Documentos

Tipos de bloco suportados

Cabeçalho (H1-H6)
Listas (ordenadas e não ordenadas)
Listas aninhadas
Imagem
Delimitador
Parágrafo
Citar
Código
Incorporar

Analisar o objeto de dados do editorjs inteiro

  const edjsParser = edjsHTML ( ) ;
  const HTML = edjsParser . parse ( editorjs_data ) ;
  // returns array of html strings per block
  console . log ( HTML ) ;

Analisar inteiros editorjs objeto de dados (modo rigoroso)

  const edjsParser = edjsHTML ( ) ;
  const HTML = edjsParser . parse ( editorjs_data ) ;
  // returns an error
  if ( HTML instanceof Error ) throw HTML ;

  // in case of success, returns an array of strings
  console . log ( HTML ) ;

Analisar um único bloco de dados limpos

  const edjsParser = edjsHTML ( ) ;
  const blockHTML = edjsParser . parseBlock ( editorjs_data_block ) ;
  // returns string of html for this block
  console . log ( blockHTML ) ;

Modo rigoroso

  const edjsParser = edjsHTML ( { } , { strict : true } ) ;
  // returns the list of missing parser functions
  const blockHTML = edjsParser . parse ( editorjs_data ) ;
  console . log ( blockHTML ) ;

Estender para blocos personalizados

editorjs-html suporta as funções do analisador estendendo e substituídas para blocos.

  // Example Custom or Unrecognised Block
  {
    type : "custom" ,
    data : {
      text : "Hello World"
    }
 }

  // Parse this block in editorjs-html
  function customParser ( block ) {
    return `<custom-tag> ${ block . data . text } </custom-tag>` ;
  }

  const plugins = {
    // The keyname must match with the type of block you want to parse with this funcion
    custom : customParser
    // ... add more or overwrite
  }

  const edjsParser =  edjsHTML ( plugins ) ;

Contribuição

Adicione um problema ou abra um PR para quaisquer bugs, revisão ou sugestões.

Novas funções do analisador

Para funções adicionais do analisador, adicione-as ao parsers/block-name . Verifique as funções existentes para obter sugestões.
O teste tudo funciona bem, com pnpm test && pnpm build .
Abra um PR, para revisão.
Adicione testes no diretório tests . Verifique se seus testes passam com a cobertura apropriada.