Skip to content

Commit

Permalink
fix:fix name import and change licences
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanvl01 committed Dec 24, 2021
1 parent ba7861e commit 74b83c5
Show file tree
Hide file tree
Showing 5 changed files with 63 additions and 74 deletions.
2 changes: 1 addition & 1 deletion CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at opensource@kissmybutton.gr. All
reported by contacting the project team at opensource@donkeyclip.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Expand Down
2 changes: 1 addition & 1 deletion LICENCE
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
Copyright 2018 KissMyButton PC (kissmybutton.gr) <opensource@kissmybutton.gr>
Copyright 2021 Donkeyclip (donkeyclip.com) <opensource@donkeyclip.com>

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:

Expand Down
102 changes: 49 additions & 53 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,22 +1,22 @@

# motorcortex-textfxs

## Demo
[Check it out here](https://kissmybutton.github.io/motorcortex-textfxs/demo/index.html)

[Check it out here](https://donkeyclip.github.io/motorcortex-textfxs/demo/index.html)

## Installation

```bash
$ npm install --save @kissmybutton/motorcortex-textfxs
$ npm install --save @donkeyclip/motorcortex-textfxs
# OR
$ yarn add @kissmybutton/motorcortex-textfxs
$ yarn add @donkeyclip/motorcortex-textfxs
```

## Loading

```javascript
const MotorCortex = require("@kissmybutton/motorcortex/");
const textfx = require("@kissmybutton/motorcortex-textfxs");
const MotorCortex = require("@donkeyclip/motorcortex/");
const textfx = require("@donkeyclip/motorcortex-textfxs");
const Plugin = MotorCortex.loadPlugin(textfx);
```

Expand All @@ -37,23 +37,23 @@ const SvgLines = new Plugin.SvgLines(
fontFamily: "Rubik Mono One",
},
{
selector: ".container3"
selector: ".container3",
}
);
```

### SvgLines Attrs

| Name | Are | Values |
| ------------- |:-------------:| -----:|
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | the list colors of svg elementes | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| fontWeight | the Weight of the font | number|
| Name | Are | Values |
| ---------- | :------------------------------: | ------------------------------------------------: |
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | the list colors of svg elementes | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| fontWeight | the Weight of the font | number |

## SvgExplosion

Expand All @@ -71,29 +71,28 @@ const SvgExplosion = new Plugin.SvgExplosion(
"#9F6AA7",
"#5476B3",
"#2BB19B",
"#70B984"
"#70B984",
],
fontFamily: "Rubik Mono One",
},
{
selector: ".container1"
selector: ".container1",
}
);
```

### SvgExplosion Attrs

| Name | Are | Values |
| ------------- |:-------------:| -----:|
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | list of colors for leter | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| fontWeight | the Weight of the font | number|

| Name | Are | Values |
| ---------- | :----------------------------: | ------------------------------------------------: |
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | list of colors for leter | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| fontWeight | the Weight of the font | number |

## Shadow

Expand All @@ -108,45 +107,42 @@ const Shadow = new Plugin.Shadow(
fontSize: 250,
textColor: "#fcedd8",
fontFamily: "Pacifico",
reverce: false
reverce: false,
},
{
selector: ".container2"
selector: ".container2",
}
);
```

### Shadow Attrs

| Name | Are | Values |
| ------------- |:-------------:| -----:|
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | the list colors of svg elementes | hex values |
| speed | animation speed. Defaults to 1 | num, min:0 |
| textColor | the main color of text | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| reverce | reverse tha animation after finish | boolean |
| fontWeight | the Weight of the font | number|

## Font
| Name | Are | Values |
| ---------- | :--------------------------------: | ------------------------------------------------: |
| text | text | string |
| width | total width of clip container | all positive numbers |
| height | total height of clip container | all positive numbers |
| background | the color of background | hex values or RGB(A) or text ("blue", "red", etc) |
| colors | the list colors of svg elementes | hex values |
| speed | animation speed. Defaults to 1 | num, min:0 |
| textColor | the main color of text | hex values or RGB(A) or text ("blue", "red", etc) |
| fontFamily | font family | string |
| fontSize | size of the font | number |
| reverce | reverse tha animation after finish | boolean |
| fontWeight | the Weight of the font | number |

## Font

if like to change the font you need to include it in to root clip properties

# Just add your incident to any clip

```javascript
anyClip.addIncident(SvgLines, 0);

```


## License
[MIT License](https://opensource.org/licenses/MIT)

[MIT License](https://opensource.org/licenses/MIT)



[![Kiss My Button](https://presskit.kissmybutton.gr/logos/kissmybutton-logo-small.png)](https://kissmybutton.gr)
[<img src="https://presskit.donkeyclip.com/logos/donkey%20clip%20logo.svg" width=250></img>](https://donkeyclip.com)
11 changes: 2 additions & 9 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"main": "dist/motorcortex-textfxs.cjs.js",
"module": "dist/motorcortex-textfxs.esm.js",
"browser": "dist/motorcortex-textfxs.umd.js",
"author": "KissMyButton PC (kissmybutton.gr) <opensource@kissmybutton.gr>",
"author": "Donkeyclip (donkeyclip.com) <opensource@donkeyclip.com>",
"repository": {
"type": "git",
"url": "https://github.com/kissmybutton/motorcortex-textfxs.git"
"url": "https://github.com/donkeyclip/motorcortex-textfxs.git"
},
"license": "MIT",
"engines": {
Expand Down Expand Up @@ -120,12 +120,5 @@
"webpack": "5.65.0",
"webpack-cli": "4.9.1",
"webpack-dev-server": "4.7.1"
},
"husky": {
"hooks": {
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS",
"pre-commit": "lint-staged",
"pre-push": "npm run test:prod"
}
}
}
20 changes: 10 additions & 10 deletions src/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,34 +6,34 @@ import {
ShadowValidation,
SvgExplosionValidation,
SvgLineValidation,
FontWeightValidation
FontWeightValidation,
} from "./validation";

import { name, version } from "../package.json";
import pkg from "../package.json";

export default {
npm_name: name,
version: version,
npm_name: pkg.name,
version: pkg.version,
incidents: [
{
exportable: SvgExplosion,
name: "SvgExplosion",
attributesValidationRules: SvgExplosionValidation
attributesValidationRules: SvgExplosionValidation,
},
{
exportable: SvgLines,
name: "SvgLines",
attributesValidationRules: SvgLineValidation
attributesValidationRules: SvgLineValidation,
},
{
exportable: Shadow,
name: "Shadow",
attributesValidationRules: ShadowValidation
attributesValidationRules: ShadowValidation,
},
{
exportable: FontWeight,
name: "FontWeight",
attributesValidationRules: FontWeightValidation
}
]
attributesValidationRules: FontWeightValidation,
},
],
};

0 comments on commit 74b83c5

Please sign in to comment.