{"id":4423,"url":"https://github.com/kunall17/react-native-markdown-editor","last_synced_at":"2025-08-04T01:32:18.521Z","repository":{"id":24101353,"uuid":"100154901","full_name":"kunall17/react-native-markdown-editor","owner":"kunall17","description":"A markdown editor like github comment editor (contains preview, helper buttons) ","archived":false,"fork":false,"pushed_at":"2022-04-26T06:15:18.000Z","size":255,"stargazers_count":108,"open_issues_count":5,"forks_count":38,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-07-23T18:56:07.016Z","etag":null,"topics":["editor","markdown","npm","package","react-native"],"latest_commit_sha":null,"homepage":"https://npmjs.com/package/react-native-markdown-editor","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/kunall17.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-08-13T04:58:51.000Z","updated_at":"2025-06-26T06:21:27.000Z","dependencies_parsed_at":"2022-08-07T11:00:54.830Z","dependency_job_id":null,"html_url":"https://github.com/kunall17/react-native-markdown-editor","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/kunall17/react-native-markdown-editor","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kunall17%2Freact-native-markdown-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kunall17%2Freact-native-markdown-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kunall17%2Freact-native-markdown-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kunall17%2Freact-native-markdown-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kunall17","download_url":"https://codeload.github.com/kunall17/react-native-markdown-editor/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kunall17%2Freact-native-markdown-editor/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":268636331,"owners_count":24282077,"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","status":"online","status_checked_at":"2025-08-03T02:00:12.545Z","response_time":2577,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["editor","markdown","npm","package","react-native"],"created_at":"2024-01-05T20:17:11.448Z","updated_at":"2025-08-04T01:32:18.160Z","avatar_url":"https://github.com/kunall17.png","language":"JavaScript","readme":"# react-native-markdown-editor\n\n[![npm version](https://badge.fury.io/js/react-native-markdown-editor.svg)](https://badge.fury.io/js/react-native-markdown-editor)\n[![Build Status](https://travis-ci.org/kunall17/react-native-markdown-editor.svg?branch=master)](https://travis-ci.org/kunall17/react-native-markdown-editor)\n\nThis is a library for rendering a markdown editor for the markdown with helper buttons to easily write markdown. With live preview markdown as well (thanks to https://github.com/Benjamin-Dobell/react-native-markdown-view)\n\n## Index\n\n* [Getting started](#getting-started)\n* [Screenshots](#screenshots)\n* [Features](#features)\n* [Usage](#usage)\n* [Customizing](#Customizing)\n    * [Your own custom formats](#your-own-custom-formats)\n    * [Customize the helper button](#customize-the-helper-button)\n    * [Customize the markdownButton styles](#customize-the-markdownbutton-styles)\n* [Props for the Markdown Editor](#props)\n* [Contributing](#contributing)\n\n## Getting Started\n\nInstall the node module:\n\n    yarn add react-native-markdown-editor\n\nor with npm:\n\n    npm install --save react-native-markdown-editor\n\nThen see [Usage](#usage) for futher details\n\n## Screenshots\n\nScreenshot:\n\n\u003cimg src=\"https://raw.githubusercontent.com/kunall17/react-native-markdown-editor/static/Screenshot.png\" width=\"40%\" /\u003e\n\n## Features\n\n* Multiline textinput for writing markdown\n* Live preview of the markdown written (can be hidden)\n* Helper buttons to write the syntax for the markdown (like github)  \n\n\n\u003cdetails\u003e\n  \u003csummary\u003eMarkdown where editor helps (in order for the default format)\u003c/summary\u003e\n\u003cp\u003e\n\n**Bold Text**\n\n*Italic Text*\n\n__Underline text__\n\n~~Strikethrough~~\n\n`Inline code`\n\n* Item 1\n* Item 2\n\nUrl Links:\n\n[GitHub](http://github.com)\n\n```\nfunction codeExample(arg) {\n}\n```\n\n# This is an \u003c h1 \u003e tag\n\n\u003c/p\u003e\n\u003c/details\u003e\n\n## Usage\n\nImport the editor through\n\n`import { MarkdownEditor } from 'react-native-markdown-editor';`\n\nAnd use like this this in the jsx\n\n`\u003cMarkdownEditor /\u003e`\n\nAnd pass a function `onMarkdownChange` which will be callback when markdown is changed\n\n```\n \u003cMarkdownEditor onMarkdownChange={this.onTextChange} /\u003e\n```\n\nIt can be used with a toolbar and have a submit menu option there!\n\n## Customizing\n\n\n##### Your own custom formats\nYou can give a custom list of buttons you want to give the default is [Formats](https://github.com/kunall17/react-native-markdown-editor/blob/master/lib/src/Formats.js) by speicifying\n\n```\n   \u003cMarkdownEditor Formats={YOUR_CUSTOM_Formats} /\u003e\n```\n\n#### Customize the helper button\n\nYou can customize the helper button using the `markdownButton` prop.\nThe buttons are rendered using a `FlatList` and the data passed is the [Formats](https://github.com/kunall17/react-native-markdown-editor/blob/master/lib/src/Formats.js)\n\nmarkdownButton can be method like\n\n```\nconst defaultMarkdownButton = ({ item, getState, setState }) =\u003e\n  \u003cButton\n    title={item.key}\n    onPress={() =\u003e item.onPress({ getState, setState, item })}\n    color={FOREGROUND_COLOR}\n    style={inlinePadding}\n  /\u003e\n```\n\nWhere item is an each object in the Formats list\n\nYou can also import the methods used in [Formats](https://github.com/kunall17/react-native-markdown-editor/blob/master/lib/src/Formats.js) by using\n\n```\nimport { applyWrapFormatNewLines, applyWrapFormat, applyWebLinkFormat, applyListFormat } from 'react-native-markdown-editor';\n```\n\n#### Customize the renderButton styles\n\nYou can add a style key in the Formats.js and this will be used while rendering the button\n\n```  \n{ key: 'B', wrapper: '**', onPress: applyWrapFormat, style: { fontWeight: 'bold' } },\n```\n\n\n## Props\n\n|       Name       |   Type   |                                                          Default                                                          |                   Description                    |\n|:---------------- |:-------- |:------------------------------------------------------------------------------------------------------------------------- |:------------------------------------------------ |\n| Formats          | Array    | [Formats](https://github.com/kunall17/react-native-markdown-editor/blob/master/lib/src/Formats.js)                        | Elements for the markdown buttons                |\n| markdownButton   | function | [defaultMarkdownButton](https://github.com/kunall17/react-native-markdown-editor/blob/master/lib/src/renderButtons.js#L9) | A custom function to render the markdown buttons |\n| onMarkdownChange | function |                                                                                                                           | Callback function, calls when markdown is typed  |\n| showPreview      | boolean  | false                                                                                                                     | To show the markdown preview by Default          |\n\n## Contributing\n\nPR's/Issues/Bugs or suggestions are welcomed. Please post them at https://github.com/kunall17/react-native-markdown-editor/issues.\n\n\n## License\n\nThe MIT License.\n\n[See LICENSE](LICENSE.md)\n","funding_links":[],"categories":["Components","Others"],"sub_categories":["Text \u0026 Rich Content","UI"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkunall17%2Freact-native-markdown-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkunall17%2Freact-native-markdown-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkunall17%2Freact-native-markdown-editor/lists"}