{"id":14462046,"url":"https://github.com/rick-yo/remind","last_synced_at":"2025-08-28T19:32:27.088Z","repository":{"id":41199307,"uuid":"250755642","full_name":"rick-yo/remind","owner":"rick-yo","description":"Bring mindmap to browser","archived":true,"fork":false,"pushed_at":"2023-10-08T10:13:58.000Z","size":2170,"stargazers_count":348,"open_issues_count":4,"forks_count":27,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-25T14:46:37.188Z","etag":null,"topics":["editor","mindmap","react","xmind"],"latest_commit_sha":null,"homepage":"https://remind.applet.ink/","language":"TypeScript","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/rick-yo.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2020-03-28T09:23:31.000Z","updated_at":"2024-11-12T07:21:34.000Z","dependencies_parsed_at":"2024-01-19T11:00:33.288Z","dependency_job_id":"e9d54e01-afd5-4166-9af2-2f4c4b8e6fc9","html_url":"https://github.com/rick-yo/remind","commit_stats":null,"previous_names":["rick-you/remind","rick-yo/remind"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rick-yo%2Fremind","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rick-yo%2Fremind/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rick-yo%2Fremind/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rick-yo%2Fremind/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rick-yo","download_url":"https://codeload.github.com/rick-yo/remind/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":231297086,"owners_count":18354596,"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":["editor","mindmap","react","xmind"],"created_at":"2024-09-01T22:01:39.736Z","updated_at":"2024-12-26T00:30:38.841Z","avatar_url":"https://github.com/rick-yo.png","language":"TypeScript","readme":"# Remind\n\n[![Build packages](https://github.com/luvsic3/remind/actions/workflows/main.yml/badge.svg)](https://github.com/luvsic3/remind/actions/workflows/main.yml)\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=unhandledrejection_mindx\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=unhandledrejection_mindx) \n\n\u003ca href=\"https://www.producthunt.com/posts/remind-4d197821-90f7-4d85-b461-f46342666c0f?utm_source=badge-featured\u0026utm_medium=badge\u0026utm_souce=badge-remind\u0026#0045;4d197821\u0026#0045;90f7\u0026#0045;4d85\u0026#0045;b461\u0026#0045;f46342666c0f\" target=\"_blank\"\u003e\u003cimg src=\"https://api.producthunt.com/widgets/embed-image/v1/featured.svg?post_id=335719\u0026theme=light\" alt=\"remind - Headless\u0026#0044;\u0026#0032;framework\u0026#0045;agnostic\u0026#0044;\u0026#0032;extendable\u0026#0032;mindmap\u0026#0032;editor\u0026#0046; | Product Hunt\" style=\"width: 250px; height: 54px;\" width=\"250\" height=\"54\" /\u003e\u003c/a\u003e\n\nA headless, framework-agnostic and extendable mindmap editor.\n\n\u003cimg src=\"./demo.png\" alt=\"drawing\" width=\"800\"/\u003e\n\n- [Try remind](https://remind.applet.ink)\n- [Play online](https://stackblitz.com/edit/typescript-nwp9sk?file=index.ts)\n- [See roadmap](https://github.com/luvsic3/remind/projects/1)\n\n# Feature\n\n * Highly extendable, take full control over styling and behavior\n * With default undo, redo, navigation, drag, CRUD, shortcut implementation (but can be replaced)\n * Framework-agnostic, remind can work with vanilla javascript, vue, react or any other framework\n * TypeScript, remind is written in typescript and has great typescript support\n\n# Installation\n\n```shell\nnpm i remind-core remind-contributions\n```\n\n# Quick Start\n\n```JavaScript\nimport { createMindmap, TopicData } from 'remind-core'\nimport 'remind-core/dist/style.css'\nimport { contributions } from 'remind-contributions'\n\nconst customData: TopicData = {\n  id: '7bf8fd567273',\n  title: 'Central Topic',\n  children: [\n    {\n      title: 'main topic 1',\n      id: 'f4cb61397246',\n    },\n    {\n      title: 'main topic 2',\n      id: 'fa4df6c9708c',\n      children: [\n        {\n          title: 'sub topic 1',\n          id: 'f4cb61397241',\n        },\n      ],\n    },\n  ],\n}\n\ncreateMindmap(document.querySelector('#app')!, {\n  value: customData,\n  contributions,\n})\n```\n\n# API\n\n## Create mindmap\n\n`instance: RefObject\u003cContributionAPI\u003e = createMindmap(containerNode, options)` \n\nRender mindmap into containerNode, return an `instance`.\n\n`instance.current` holds `ContributionAPI`, which let you change editor's content, undo redo history, change selected topic... \n\nsee `packages/core/src/interface/contribute.ts` for more.\n\n### options\n\n| option        | type                         | description            | default |\n| ------------- | ---------------------------- | ---------------------- | ------- |\n| value         | TopicData                    | set mindmap data       | -       |\n| onChange      | (value: TopicData) =\u003e void   | listen to value change | -       |\n| layout        | 'mindmap' \u0026#124; 'structure' | -                      | mindmap |\n| locale        | 'en' \u0026#124; 'cn' \u0026#124; 'ja' | language localization  | en      |\n| theme         | Theme                        | -                      | -       |\n| contributions | Contribution[]               | -                      | []      |\n\n`options.layout` can changed layout algorithm\n\n`options.theme` let you customize mindmap style, see `packages/core/src/interface/theme.ts` for more documentation \n\n`options.contributions` can extend editor's functionality, custom editor's behavior or add custom render content. see `packages/contributions/src` how to use it.\n\n## Export mindmap as svg/image\n\nSee `/packages/core/src/utils/to`, how to use it\n\n\n## License\n\n[MIT License](https://github.com/luvsic3/remind/blob/master/LICENSE)\n","funding_links":[],"categories":["TypeScript"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frick-yo%2Fremind","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frick-yo%2Fremind","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frick-yo%2Fremind/lists"}