{"id":13725053,"url":"https://github.com/utkarshdubey/react-spline","last_synced_at":"2025-05-07T19:32:39.317Z","repository":{"id":52611055,"uuid":"333415039","full_name":"utkarshdubey/react-spline","owner":"utkarshdubey","description":"A wrapper to painlessly integrate Spline projects into your React code-space. ☀","archived":true,"fork":false,"pushed_at":"2022-03-26T03:55:15.000Z","size":14672,"stargazers_count":83,"open_issues_count":8,"forks_count":14,"subscribers_count":4,"default_branch":"main","last_synced_at":"2024-09-30T06:29:45.780Z","etag":null,"topics":["animation","react","react-spline","spline","threejs"],"latest_commit_sha":null,"homepage":"https://utkarshdubey.github.io/react-spline/","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/utkarshdubey.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-01-27T12:35:41.000Z","updated_at":"2024-04-15T12:56:53.000Z","dependencies_parsed_at":"2022-08-25T15:51:07.106Z","dependency_job_id":null,"html_url":"https://github.com/utkarshdubey/react-spline","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarshdubey%2Freact-spline","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarshdubey%2Freact-spline/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarshdubey%2Freact-spline/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/utkarshdubey%2Freact-spline/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/utkarshdubey","download_url":"https://codeload.github.com/utkarshdubey/react-spline/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224170413,"owners_count":17267572,"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":["animation","react","react-spline","spline","threejs"],"created_at":"2024-08-03T01:02:11.017Z","updated_at":"2024-11-14T15:30:40.508Z","avatar_url":"https://github.com/utkarshdubey.png","language":"JavaScript","funding_links":[],"categories":["JavaScript"],"sub_categories":[],"readme":"# React Spline\n\n[![NPM](https://img.shields.io/npm/v/react-spline.svg)](https://www.npmjs.com/package/react-spline) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)\n\n## Archive Notice\nThe repository has been archived now since Spline has released their official library [@splinetool/react-spline](https://www.npmjs.com/package/@splinetool/react-spline) for importing models. I had fun maintaining this project, if your existing workspace is using `react-spline`, the transitioning won't be hard since most of the generics are similar. Thanks for stopping by.\n\nA painless, configurable, [spline](https://spline.design) wrapper for React to add sweet animations easily into your projects.\n\n![Demo Gif](./demo.gif)\n\n## Install\n\n```bash\nnpm install --save react-spline\n```\n\nor\n\n```bash\nyarn add react-spline\n```\n\n## Usage\n\nImport the `Spline` component from `react-spline` and you're set.\n\n```tsx\nimport React, { Component } from 'react'\n\nimport { Spline } from 'react-spline'\nimport SCENE_OBJECT from './scene.json'\n\nclass Example extends Component {\n  render() {\n    return \u003cSpline scene={SCENE_OBJECT} /\u003e\n  }\n}\n```\n\n## Props\n\n| Property              | Description                                                              |\n| --------------------- | ------------------------------------------------------------------------ |\n| scene `object`        | Required. The scene object exported from Spline.                         |\n| id `string`           | Default empty. Assignable HTMLAttribute `id` for the `\u003ccanvas\u003e` element. |\n| className `string`    | Default empty. Assignable HTMLAttribute `class` for the `\u003cdiv\u003e` wrapper. |\n| style `JSX CSS`       | Default empty. Custom styling for the `\u003cdiv\u003e` wrapper.                   |\n| canvasStyle `JSX CSS` | Default empty. Custom styling for the `\u003ccanvas\u003e` element.                |\n\n## Loading the Spline model\nTo download Spline models from the link that gets generated in Spline, it's accessible at ``https://my.spline.design/example-8b43571.../scene.json`` (**Note**: Here *example-8b43571* in the link is a placeholder for a Spline generated link). You can then import the object and use it like shown above.\n\n## Multiple THREE.js Warning Issue\nThe older versions of this library experience a ~~bug~~ problem, where outdated usage of functions in the Spline runtime cause multiple duplicate warnings to clutter the console. For now, it has been disabled by a workaround script that removes duplicate warnings from the console until we have a proper solution.\n\n## License\n\nMIT © [utkarshdubey](https://github.com/utkarshdubey)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futkarshdubey%2Freact-spline","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Futkarshdubey%2Freact-spline","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Futkarshdubey%2Freact-spline/lists"}