Skip to content

Commit 680a1dd

Browse files
authored
Merge pull request #67 from PiwikPRO/PPI-1551
[PPI-1511] add new methods for download classes
2 parents 142e080 + bfa4b24 commit 680a1dd

4 files changed

Lines changed: 66 additions & 15 deletions

File tree

README.md

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1025,9 +1025,12 @@ ___
10251025
### Table of contents
10261026

10271027

1028+
- [addDownloadClasses](#adddownloadclasses)
10281029
- [addDownloadExtensions](#adddownloadextensions)
10291030
- [enableLinkTracking](#enablelinktracking)
1031+
- [getDownloadClasses](#getdownloadclasses)
10301032
- [getLinkTrackingTimer](#getlinktrackingtimer)
1033+
- [removeDownloadClasses](#removedownloadclasses)
10311034
- [removeDownloadExtensions](#removedownloadextensions)
10321035
- [setDownloadClasses](#setdownloadclasses)
10331036
- [setDownloadExtensions](#setdownloadextensions)
@@ -1037,6 +1040,24 @@ ___
10371040
- [trackLink](#tracklink)
10381041

10391042

1043+
#### addDownloadClasses
1044+
1045+
**addDownloadClasses**(`classes`): `void`
1046+
1047+
Adds new classes to the download classes list
1048+
1049+
##### Parameters
1050+
1051+
| Name | Type |
1052+
| :------ | :------ |
1053+
| `classes` | `string`[] |
1054+
1055+
##### Returns
1056+
1057+
`void`
1058+
1059+
___
1060+
10401061
#### addDownloadExtensions
10411062

10421063
**addDownloadExtensions**(`extensions`): `void`
@@ -1076,6 +1097,18 @@ to a downloadable file creates a download event
10761097

10771098
___
10781099

1100+
#### getDownloadClasses
1101+
1102+
**getDownloadClasses**(): `Promise`\<`string`[]\>
1103+
1104+
Returns list of download classes (CSS classes that indicate a link is a download)
1105+
1106+
##### Returns
1107+
1108+
`Promise`\<`string`[]\>
1109+
1110+
___
1111+
10791112
#### getLinkTrackingTimer
10801113

10811114
**getLinkTrackingTimer**(): `Promise`\<`number`\>
@@ -1088,6 +1121,24 @@ Returns lock/wait time after a request set by setLinkTrackingTimer
10881121

10891122
___
10901123

1124+
#### removeDownloadClasses
1125+
1126+
**removeDownloadClasses**(`classes`): `void`
1127+
1128+
Removes classes from the download classes list
1129+
1130+
##### Parameters
1131+
1132+
| Name | Type |
1133+
| :------ | :------ |
1134+
| `classes` | `string`[] |
1135+
1136+
##### Returns
1137+
1138+
`void`
1139+
1140+
___
1141+
10911142
#### removeDownloadExtensions
10921143

10931144
**removeDownloadExtensions**(`extensions`): `void`

example/yarn.lock

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -465,14 +465,14 @@
465465
fastq "^1.6.0"
466466

467467
"@piwikpro/react-piwik-pro@file:..":
468-
version "2.5.0"
468+
version "2.6.0"
469469
dependencies:
470-
"@piwikpro/tracking-base-library" "^1.6.0"
470+
"@piwikpro/tracking-base-library" "^1.7.0"
471471

472-
"@piwikpro/tracking-base-library@^1.6.0":
473-
version "1.6.0"
474-
resolved "https://registry.yarnpkg.com/@piwikpro/tracking-base-library/-/tracking-base-library-1.6.0.tgz#c08ac7331c514e9c2610669720cac9f99bad6a9b"
475-
integrity sha512-jd88qqxGAtjSfdDLPuFzrk1hjnIQKCdSFynm3GE/fHB0drPsXZ/o1oXPY9YpAVX2dIkurrycRAzEhtC6KwSlfw==
472+
"@piwikpro/tracking-base-library@^1.7.0":
473+
version "1.7.0"
474+
resolved "https://registry.yarnpkg.com/@piwikpro/tracking-base-library/-/tracking-base-library-1.7.0.tgz#322f1f958ee9bd7a7e637d53c5458ad134ee3fb0"
475+
integrity sha512-0u5YTcYO2As9T6ZFuJn0da6VYWz0sVYFFujkwiD8fz0o+Jjvl8r8Fk7rM2/ifLs03bqBOYe8MZRCjDKHWQzaiQ==
476476

477477
"@popperjs/core@^2.11.8":
478478
version "2.11.8"

package.json

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@piwikpro/react-piwik-pro",
3-
"version": "2.5.0",
3+
"version": "2.6.0",
44
"description": "Piwik PRO tracking library for ReactJS",
55
"author": "Piwik Pro Integration Team <integrations@piwik.pro>",
66
"license": "MIT",
@@ -37,6 +37,7 @@
3737
},
3838
"devDependencies": {
3939
"@babel/plugin-proposal-unicode-property-regex": "^7.18.6",
40+
"@rollup/plugin-typescript": "^11.1.6",
4041
"@testing-library/jest-dom": "^6.2.0",
4142
"@testing-library/react": "^14.1.2",
4243
"@testing-library/user-event": "^14.5.2",
@@ -47,23 +48,22 @@
4748
"@typescript-eslint/eslint-plugin": "^6.18.0",
4849
"@typescript-eslint/parser": "^6.18.0",
4950
"babel-eslint": "^10.1.0",
51+
"concat-md": "^0.5.1",
5052
"cross-env": "^7.0.3",
5153
"eslint": "^8.56.0",
5254
"gh-pages": "^6.1.1",
5355
"prettier": "^3.1.1",
5456
"react": "^18.2.0",
55-
"typescript": "^5.2.2",
56-
"@rollup/plugin-typescript": "^11.1.6",
57-
"concat-md": "^0.5.1",
5857
"tslib": "^2.6.3",
5958
"typedoc": "^0.25.13",
6059
"typedoc-plugin-markdown": "^3.17.1",
60+
"typescript": "^5.2.2",
6161
"vite": "^5.3.1"
6262
},
6363
"files": [
6464
"dist"
6565
],
6666
"dependencies": {
67-
"@piwikpro/tracking-base-library": "^1.6.0"
67+
"@piwikpro/tracking-base-library": "^1.7.0"
6868
}
6969
}

yarn.lock

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -355,10 +355,10 @@
355355
"@nodelib/fs.scandir" "2.1.5"
356356
fastq "^1.6.0"
357357

358-
"@piwikpro/tracking-base-library@^1.6.0":
359-
version "1.6.0"
360-
resolved "https://registry.yarnpkg.com/@piwikpro/tracking-base-library/-/tracking-base-library-1.6.0.tgz#c08ac7331c514e9c2610669720cac9f99bad6a9b"
361-
integrity sha512-jd88qqxGAtjSfdDLPuFzrk1hjnIQKCdSFynm3GE/fHB0drPsXZ/o1oXPY9YpAVX2dIkurrycRAzEhtC6KwSlfw==
358+
"@piwikpro/tracking-base-library@^1.7.0":
359+
version "1.7.0"
360+
resolved "https://registry.yarnpkg.com/@piwikpro/tracking-base-library/-/tracking-base-library-1.7.0.tgz#322f1f958ee9bd7a7e637d53c5458ad134ee3fb0"
361+
integrity sha512-0u5YTcYO2As9T6ZFuJn0da6VYWz0sVYFFujkwiD8fz0o+Jjvl8r8Fk7rM2/ifLs03bqBOYe8MZRCjDKHWQzaiQ==
362362

363363
"@rollup/plugin-typescript@^11.1.6":
364364
version "11.1.6"

0 commit comments

Comments
 (0)