{"id":18365339,"url":"https://github.com/ballcat-projects/vue-cropper","last_synced_at":"2025-04-10T13:18:22.256Z","repository":{"id":37282717,"uuid":"504178280","full_name":"ballcat-projects/vue-cropper","owner":"ballcat-projects","description":"vue image cropper components by cropperjs.","archived":false,"fork":false,"pushed_at":"2023-11-08T03:03:03.000Z","size":2570,"stargazers_count":15,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-02-15T19:51:17.387Z","etag":null,"topics":["cropper","cropperjs","vue-cropperjs","vue3"],"latest_commit_sha":null,"homepage":"https://ballcat-projects.github.io/vue-cropper/","language":"Vue","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/ballcat-projects.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-06-16T14:02:02.000Z","updated_at":"2025-01-18T00:25:14.000Z","dependencies_parsed_at":"2024-12-24T00:27:32.943Z","dependency_job_id":"2d69b6c3-32bf-4a9f-bfde-f769b89d18a3","html_url":"https://github.com/ballcat-projects/vue-cropper","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ballcat-projects%2Fvue-cropper","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ballcat-projects%2Fvue-cropper/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ballcat-projects%2Fvue-cropper/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ballcat-projects%2Fvue-cropper/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ballcat-projects","download_url":"https://codeload.github.com/ballcat-projects/vue-cropper/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248225656,"owners_count":21068078,"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":["cropper","cropperjs","vue-cropperjs","vue3"],"created_at":"2024-11-05T23:13:11.954Z","updated_at":"2025-04-10T13:18:22.232Z","avatar_url":"https://github.com/ballcat-projects.png","language":"Vue","funding_links":[],"categories":[],"sub_categories":[],"readme":"# vue-cropper\n\nA Vue image cropper components by cropperjs.\n\nGithub: https://github.com/ballcat-projects/vue-cropper\n\n## Demo\n\nonline demo: https://ballcat-projects.github.io/vue-cropper\n\nYou can also clone the repository and run the demo locally:\n\n```shell\n# clone\ngit clone https://github.com/ballcat-projects/vue-cropper.git\n\n# enter the folder\ncd vue-cropper/example\n\n# install dependency\nnpm install\n\n# run it\nnpm run dev\n```\n\n## Getting started\n\n### Installation\n\n```npm\nnpm install @ballcat/vue-cropper\n```\nor\n```yarn\nyarn add @ballcat/vue-cropper\n```\n\n### Usage\n\n#### Global Registration\n\n```vue\nimport { createApp } from 'vue';\nimport App from './App';\n\nimport VueCropper from '@ballcat/vue-cropper';\nimport 'cropperjs/dist/cropper.css';\n\nconst app = createApp(App);\n\napp.use(VueCropper).mount('#app');\n```\n\n#### Local Registration\n\n```vue\n\u003ctemplate\u003e\n  \u003cvue-cropper \n      ref=\"vueCropperRef\"\n      :src=\"imgSrc\"\n      alt=\"Source Image\"\n  /\u003e\n\u003c/template\u003e\n\u003cscript\u003e\nimport {ref, onMounted} from 'vue'\nimport VueCropper from '@ballcat/vue-cropper';\nimport 'cropperjs/dist/cropper.css';\n\nexport default {\n  components: {\n    VueCropper,\n  },\n  setup() {\n    const imgSrc = ref('the image path')\n    const vueCropperRef = ref(null);\n\n    onMounted(() =\u003e {\n      console.log(vueCropperRef.value.getData());\n    });\n\n    return {\n      imgSrc,\n      vueCropperRef\n    };\n  }\n};\n\u003c/script\u003e\n```\n\nor use setup script\n\n```vue\n\u003cscript setup\u003e\nimport {ref, onMounted} from 'vue'\nimport VueCropper from '@ballcat/vue-cropper';\nimport 'cropperjs/dist/cropper.css';\n\nconst imgSrc = ref('the image path')\nconst vueCropperRef = ref(null);\n\nonMounted(() =\u003e {\n  console.log(vueCropperRef.value.getData());\n});\n\u003c/script\u003e\n```\n\n## API\n\nVueCropper props that can be used are divided into two parts, custom and all properties supported by cropperjs\n\n### custom options\n\n| Property       | Description                                 | Type    | Required |\n| :------------- | :------------------------------------------ | :------ | :------- |\n| src            | origin image src                            | string  | true     |\n| imgStyle       | the img element style                       | object  | --       |\n| imgCrossOrigin | the img element crossOrigin attribute value | string  | --       |\n| alt            | the img element alt attribute value         | boolean | --       |\n\n### Cropperjs options\n\nsee [cropperjs document](https://github.com/fengyuanchen/cropperjs/blob/main/README.md)\n\n\n### custom expose method\n\n| Method  | Description                   | Type       |\n|:--------|:------------------------------|:-----------|\n| flipX   | flip the picture horizontally | () =\u003e void |\n| flipY   | flip the picture vertically   | () =\u003e void |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fballcat-projects%2Fvue-cropper","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fballcat-projects%2Fvue-cropper","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fballcat-projects%2Fvue-cropper/lists"}