{"id":21009505,"url":"https://github.com/limitkr/react-abc-editor","last_synced_at":"2025-06-24T22:33:00.117Z","repository":{"id":152893194,"uuid":"469322270","full_name":"limitkr/react-abc-editor","owner":"limitkr","description":"React component for showing and writing abc notations using the Abcjs library","archived":false,"fork":false,"pushed_at":"2023-08-21T18:22:43.000Z","size":190,"stargazers_count":2,"open_issues_count":2,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-20T11:11:33.576Z","etag":null,"topics":["abc-notation","abcjs","abcnotation","react","react-components"],"latest_commit_sha":null,"homepage":"","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/limitkr.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,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-03-13T09:16:25.000Z","updated_at":"2023-08-18T06:54:58.000Z","dependencies_parsed_at":null,"dependency_job_id":"518efa5d-d6cc-428e-9ab6-23f4b2aa9206","html_url":"https://github.com/limitkr/react-abc-editor","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/limitkr%2Freact-abc-editor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limitkr%2Freact-abc-editor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limitkr%2Freact-abc-editor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/limitkr%2Freact-abc-editor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/limitkr","download_url":"https://codeload.github.com/limitkr/react-abc-editor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243431269,"owners_count":20289866,"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":["abc-notation","abcjs","abcnotation","react","react-components"],"created_at":"2024-11-19T09:17:02.287Z","updated_at":"2025-03-13T15:27:47.288Z","avatar_url":"https://github.com/limitkr.png","language":"TypeScript","readme":"# react-abc-editor\n\nReact component for showing and writing abc notations using the Abcjs library.\u003cbr\u003e\nThank you [@paulrosen](https://github.com/paulrosen) for creator of Abcjs library.\n\n# Quick Start\n\n## Install\n\n```bash\n# Using npm:\nnpm i react-abc-editor\n# or Yarn package manager:\nyarn add react-abc-editor\n```\n\n## Update (2023-08-22)\nThe `\u003cAbcTextEditor /\u003e` component is scheduled to be deprecated in the next major release for the following two reasons:\n\n1. The React team is planning to discontinue support for `defaultProps`. see [pull requests](https://github.com/facebook/react/pull/25699)\n2. The current component structure is deemed difficult to extend.\n\nThe new component will additionally support the following features:\n1. Styling\n2. Interactive Editor\n\n## Basic Usage\n\n```tsx\n// App.tsx\n\nimport React from \"react\";\nimport { AbcTextEditor } from \"react-abc-editor\";\n\nexport default function App() {\n  return \u003cAbcTextEditor /\u003e;\n}\n```\n\n### Disable Edit mode and Click event\n\nIf you want to TextEditor as read-only, set `allowEdit` to false for disable textarea, and set `allowClick` to false for disable click event.\n\n```tsx\n// App.tsx\n\nimport React from \"react\";\nimport { AbcTextEditor } from \"react-abc-editor\";\n\nexport default function App() {\n  return \u003cAbcTextEditor allowEdit={false} allowClick={false} /\u003e;\n}\n```\n\n### Use predefined abc tune\n\nIf you want to use the pre-made abc notation string, assign it to the `predefinedAbcString` prop.\n\n```tsx\n// App.tsx\n\nimport React from \"react\";\nimport { AbcTextEditor } from \"react-abc-editor\";\n\nconst tune = \"X: 1\\nT: Cooley's\\nM: 4/4\\nL: 1/8\\nK: Emin\\n|:D2|\"Em\"EBBA B2 EB||\"\n\nexport default function App() {\n  return \u003cAbcTextEditor predefinedAbcString={tune} /\u003e;\n}\n```\n\n## Use Abcjs render options\n\n```tsx\ninterface TextEditorProps {\n  options?: Omit\u003cAbcVisualParams, \"selectTypes\" | \"dragging\"\u003e;\n}\n```\n\nNot required. However, you can set the `options` prop for advanced settings to visualizing score.\n\n```tsx\nimport React from \"react\";\nimport { AbcTextEditor } from \"react-abc-editor\";\n\nexport default function App() {\n  return \u003cAbcTextEditor options={{ draggingColor: \"orange\" }} /\u003e;\n}\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimitkr%2Freact-abc-editor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flimitkr%2Freact-abc-editor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flimitkr%2Freact-abc-editor/lists"}