{"id":15627664,"url":"https://github.com/bpetetot/react-pell","last_synced_at":"2025-10-26T07:33:09.985Z","repository":{"id":37743236,"uuid":"97632789","full_name":"bpetetot/react-pell","owner":"bpetetot","description":"React component wrapping the wysiwyg pell editor for HTML and Markdown","archived":false,"fork":false,"pushed_at":"2023-01-12T10:39:53.000Z","size":1214,"stargazers_count":33,"open_issues_count":35,"forks_count":14,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-11T02:19:26.524Z","etag":null,"topics":["component","editor","html","javascript","markdown","pell","react","wysiwyg"],"latest_commit_sha":null,"homepage":"https://bpetetot.github.io/react-pell/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/bpetetot.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-07-18T18:50:46.000Z","updated_at":"2022-12-14T10:02:35.000Z","dependencies_parsed_at":"2023-02-09T11:16:40.677Z","dependency_job_id":null,"html_url":"https://github.com/bpetetot/react-pell","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpetetot%2Freact-pell","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpetetot%2Freact-pell/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpetetot%2Freact-pell/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bpetetot%2Freact-pell/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bpetetot","download_url":"https://codeload.github.com/bpetetot/react-pell/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248860218,"owners_count":21173342,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["component","editor","html","javascript","markdown","pell","react","wysiwyg"],"created_at":"2024-10-03T10:18:35.048Z","updated_at":"2025-10-26T07:33:09.924Z","avatar_url":"https://github.com/bpetetot.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# react-pell\n\n\u003e React component wrapping a HTML and Markdown editor based on [the wysiwyg pell editor](https://github.com/jaredreich/pell)\n\n## Contents\n - [Getting started](#getting-started)\n - [HTML Editor](#html-editor)\n - [Markdown Editor](#markdown-editor)\n\n## Getting started\n\nInstall react-pell as dependency :\n```\n  yarn add react-pell\n```\n\nBasic example :\n```es6\nimport React, { Component } from 'react';\nimport Editor from 'react-pell'\n\nclass App extends Component {\n\n  handleChange(html) {\n    console.log(html)\n  }\n\n  render() {\n    return (\n      \u003cEditor onChange={this.handleChange.bind(this)} /\u003e\n    );\n  }\n}\n\nexport default App;\n```\n\n## HTML editor\n\nA basic wrapping of the [pell editor](https://github.com/jaredreich/pell).\n\n**Import the Editor :**\n```es6\nimport Editor from 'react-pell'\n```\n\n**Example :**\n```es6\n  \u003cEditor\n    defaultContent=\"\u003cb\u003ehello world\u003c/b\u003e\"\n    actions={['bold', 'italic']}\n    actionBarClass=\"my-custom-class\"\n    onChange={this.handleChange}\n  /\u003e\n```\n\n**Prop types :**\n\nproperty | type | required | description\n----------|------|----------|------------\nonChange | func | true | function handling changes from the editor, the output html is the first parameter\ndefaultContent | string | false | default content of the editor (HTML serialized in a string)\nactions | array | false | table of available actions or custom actions in the editor ([watch pell documentation for more details](https://github.com/jaredreich/pell/blob/master/README.md)) **Note:** `pell` instance is given at first parameter of `result` callback of custom actions. (default: `['bold', 'italic', 'underline', 'strikethrough', 'heading1', 'heading2', 'olist', 'ulist', 'quote', 'code', 'line']`).\nstyleWithCSS | bool | false | outputs styles with css instead of HTML elements (default: `false`)\ncontainerClass | string | false | class name of the container (default: `pell-container`)\nactionBarClass | string | false | class name of the action bar (default: `pell-actionbar`)\nbuttonClass | string | false | class name of buttons (default: `pell-button`)\ncontentClass | string | false | class name of the content (default: `pell-content`)\n\n## Markdown editor\n\nThis editor plugin extends the behaviour of [pell](https://github.com/jaredreich/pell) to edit markdown.\nWe are using following libraries to manage markdown :\n- html to markdown : [`to-markdown`](https://github.com/domchristie/to-markdown)\n- markdown to html : [`showdown`](https://github.com/showdownjs/showdown)\n\n**Import the Editor :**\n```es6\nimport Editor from 'react-pell/plugins/markdown'\n```\n\n**Example :**\n```es6\n  \u003cEditor\n    defaultContent=\"**hello world**\"\n    actions={['bold', 'italic']}\n    actionBarClass=\"my-custom-class\"\n    onChange={this.handleChange}\n    gmf={false}\n  /\u003e\n```\n\n**Prop types :**\n\nSame props as the Basic HTML pell editor with following props added :\n\nproperty | type | required | description\n----------|------|----------|------------\nconverters | array | false | converters used to handle custom convertions from HTML to markdown. [see to-markdown documentation for more details](https://github.com/domchristie/to-markdown/blob/master/README.md#converters-array)\ngmf | bool | true | beta support for GitHub flavored markdown (GFM)\n\n## LICENSE\n\nMIT","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbpetetot%2Freact-pell","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbpetetot%2Freact-pell","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbpetetot%2Freact-pell/lists"}