From e66cdfd6038e521a346c7158444c302ddd30f657 Mon Sep 17 00:00:00 2001 From: RaresAil Date: Wed, 27 Mar 2024 14:22:58 +0200 Subject: [PATCH 1/2] add spin animation --- .svgrrc.js | 4 +- LICENSE | 211 ++++++++++++++++++++++++++++++++++++++++++----- package.json | 4 +- src/style.css | 19 +++++ src/types.ts | 6 ++ templates/svg.js | 16 +++- 6 files changed, 234 insertions(+), 26 deletions(-) create mode 100644 src/style.css create mode 100644 src/types.ts diff --git a/.svgrrc.js b/.svgrrc.js index 7ba86b7..192ab62 100644 --- a/.svgrrc.js +++ b/.svgrrc.js @@ -8,6 +8,8 @@ module.exports = { memo: true, icon: true, svgProps: { - fill: 'currentColor' + fill: 'currentColor', + className: '{`raresail-react-ionicon ${className}`}', + 'data-animation': '{animation}' } }; diff --git a/LICENSE b/LICENSE index bb8919b..bb78341 100644 --- a/LICENSE +++ b/LICENSE @@ -1,21 +1,190 @@ -MIT License - -Copyright (c) 2024 Nicolae-Rares Ailincai - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + +TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + +1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + +2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + +3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + +4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + +5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + +6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + +7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + +8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + +9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + +END OF TERMS AND CONDITIONS + +Copyright 2024 Nicolae-Rares Ailincai + +Licensed under the Apache License, Version 2.0 (the "License"); +you may not use this file except in compliance with the License. +You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + +Unless required by applicable law or agreed to in writing, software +distributed under the License is distributed on an "AS IS" BASIS, +WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +See the License for the specific language governing permissions and +limitations under the License. diff --git a/package.json b/package.json index 8b26551..675e33c 100644 --- a/package.json +++ b/package.json @@ -1,9 +1,9 @@ { "name": "@raresail/react-ionicons", - "version": "1.1.1", + "version": "2.0.0", "repository": "git@github.com:RaresAil/react-ionicons.git", "author": "RaresAil ", - "license": "MIT", + "license": "Apache-2.0", "private": false, "main": "dist/cjs/index.js", "module": "dist/esm/index.js", diff --git a/src/style.css b/src/style.css new file mode 100644 index 0000000..62c23a2 --- /dev/null +++ b/src/style.css @@ -0,0 +1,19 @@ +@keyframes raresail-react-ionicon-spin { + from { + transform: rotate(0deg); + } + to { + transform: rotate(360deg); + } +} + +.raresail-react-ionicon { + box-sizing: content-box; +} + +.raresail-react-ionicon[data-animation='spin'] { + animation-name: raresail-react-ionicon-spin; + animation-iteration-count: infinite; + animation-timing-function: linear; + animation-duration: 2500ms; +} diff --git a/src/types.ts b/src/types.ts new file mode 100644 index 0000000..ad8a65d --- /dev/null +++ b/src/types.ts @@ -0,0 +1,6 @@ +import { SVGProps } from 'react'; + +export interface IonIconProps + extends Omit, 'fill' | 'stroke'> { + spin?: true; +} diff --git a/templates/svg.js b/templates/svg.js index 5b9f0b8..cea5b2e 100644 --- a/templates/svg.js +++ b/templates/svg.js @@ -2,13 +2,25 @@ const propTypesTemplate = ( { /* imports, */ interfaces, componentName, jsx, exports }, { tpl } ) => { - return tpl`import { SVGProps, memo } from 'react'; + return tpl`import '../style.css'; +import { memo, useMemo } from 'react'; +import { IonIconProps } from '../types'; ${interfaces} function ${componentName}({ strokeWidth, + className, + spin, ...props -}: Omit, 'fill' | 'stroke'>) { +}: IonIconProps) { + const animation = useMemo(() => { + if (spin) { + return 'spin'; + } + + return ''; + }, [spin]); + return ${jsx}; } From a8c4fdd97d7ee6760397835e6243e38a858801ca Mon Sep 17 00:00:00 2001 From: RaresAil Date: Wed, 27 Mar 2024 14:49:08 +0200 Subject: [PATCH 2/2] beat animation --- README.md | 22 ++++++++++++++++++++++ src/style.css | 19 +++++++++++++++++++ src/types.ts | 1 + templates/svg.js | 5 +++++ 4 files changed, 47 insertions(+) diff --git a/README.md b/README.md index c187ece..c782553 100644 --- a/README.md +++ b/README.md @@ -51,3 +51,25 @@ function Component() { | strokeWidth | number \| string | 32 or 16 | | className | string | | | ... | Other SVG Props | | + +### Animations + +#### Spin + +To spin a icon add the `spin` prop, if you want to adjust the speed, use the `animation-duration` css property + +```tsx +function() { + return ; +} +``` + +#### Beat + +To spin a icon add the `beat` prop, if you want to adjust the speed, use the `animation-duration` css property + +```tsx +function() { + return ; +} +``` diff --git a/src/style.css b/src/style.css index 62c23a2..76baa41 100644 --- a/src/style.css +++ b/src/style.css @@ -7,6 +7,18 @@ } } +@keyframes raresail-react-ionicon-beat { + 0%, + 50%, + 100% { + transform: scale(1); + } + 30%, + 80% { + transform: scale(1.1); + } +} + .raresail-react-ionicon { box-sizing: content-box; } @@ -17,3 +29,10 @@ animation-timing-function: linear; animation-duration: 2500ms; } + +.raresail-react-ionicon[data-animation='beat'] { + animation-name: raresail-react-ionicon-beat; + animation-iteration-count: infinite; + animation-timing-function: ease; + animation-duration: 1.5s; +} diff --git a/src/types.ts b/src/types.ts index ad8a65d..d3076df 100644 --- a/src/types.ts +++ b/src/types.ts @@ -3,4 +3,5 @@ import { SVGProps } from 'react'; export interface IonIconProps extends Omit, 'fill' | 'stroke'> { spin?: true; + beat?: true; } diff --git a/templates/svg.js b/templates/svg.js index cea5b2e..c6bca02 100644 --- a/templates/svg.js +++ b/templates/svg.js @@ -11,6 +11,7 @@ function ${componentName}({ strokeWidth, className, spin, + beat, ...props }: IonIconProps) { const animation = useMemo(() => { @@ -18,6 +19,10 @@ function ${componentName}({ return 'spin'; } + if (beat) { + return 'beat'; + } + return ''; }, [spin]);