search

dbmdz / mirador-textoverlay

Text Overlay plugin for Mirador 3
https://mirador-textoverlay.netlify.com/
MIT License
50 stars 14 forks source link

How to use it with v3 #296

Closed belkin closed 2 months ago

belkin commented 1 year ago

I'm looking for guidance on how to effectively use the dbmdz/mirador-textoverlay plugin with Mirador 3. I've attempted to install it via the iiifv3 branch, but I've encountered an issue where the folder in the node_modules directory appears to be empty.

Steps Taken

I attempted to install the dbmdz/mirador-textoverlay plugin using the iiifv3 branch with the following command:

npm install dbmdz/mirador-textoverlay#iiifv3

image

jbaiter commented 1 year ago

Have you tried checking out locally and adding it as a local dependency? I'm not sure if the package has to do something special to support the branch qualifier, it's the first time I'm seeing it.

belkin commented 1 year ago

But that would mean that I need to install every dependency in my project also?

Also I got the empty folder with --force flag: npm install dbmdz/mirador-textoverlay#iiifv3 --force. I think that was an attempt to fix following dependency error:

npm install mirador dbmdz/mirador-textoverlay#iiifv3

npm ERR! code ERESOLVE
npm ERR! ERESOLVE unable to resolve dependency tree
npm ERR! 
npm ERR! While resolving: undefined@undefined
npm ERR! Found: react@17.0.2
npm ERR! node_modules/react
npm ERR!   peer react@"^16.8.0 || ^17.0.0" from @material-ui/core@4.12.4
npm ERR!   node_modules/@material-ui/core
npm ERR!     peer @material-ui/core@"^4.11.0" from mirador-textoverlay@0.3.8
npm ERR!     node_modules/mirador-textoverlay
npm ERR!       mirador-textoverlay@"dbmdz/mirador-textoverlay#iiifv3" from the root project
npm ERR!     peer @material-ui/core@"^4.0.0" from @material-ui/icons@4.11.3
npm ERR!     node_modules/@material-ui/icons
npm ERR!       peer @material-ui/icons@"^4.9.1" from mirador-textoverlay@0.3.8
npm ERR!       node_modules/mirador-textoverlay
npm ERR!         mirador-textoverlay@"dbmdz/mirador-textoverlay#iiifv3" from the root project
npm ERR!       1 more (mirador)
npm ERR!     2 more (@material-ui/lab, mirador)
npm ERR!   peer react@"17.0.2" from react-dom@17.0.2
npm ERR!   node_modules/react-dom
npm ERR!     peer react-dom@"^16.8.0 || ^17.0.0" from @material-ui/core@4.12.4
npm ERR!     node_modules/@material-ui/core
npm ERR!       peer @material-ui/core@"^4.11.0" from mirador-textoverlay@0.3.8
npm ERR!       node_modules/mirador-textoverlay
npm ERR!         mirador-textoverlay@"dbmdz/mirador-textoverlay#iiifv3" from the root project
npm ERR!       3 more (@material-ui/icons, @material-ui/lab, mirador)
npm ERR!     peer react-dom@"^16.8.0 || ^17.0.0" from @material-ui/icons@4.11.3
npm ERR!     node_modules/@material-ui/icons
npm ERR!       peer @material-ui/icons@"^4.9.1" from mirador-textoverlay@0.3.8
npm ERR!       node_modules/mirador-textoverlay
npm ERR!         mirador-textoverlay@"dbmdz/mirador-textoverlay#iiifv3" from the root project
npm ERR!       1 more (mirador)
npm ERR!     1 more (@material-ui/lab)
npm ERR!   2 more (@material-ui/icons, @material-ui/lab)
npm ERR! 
npm ERR! Could not resolve dependency:
npm ERR! peer react@"^16.8.3" from mirador@3.3.0
npm ERR! node_modules/mirador
npm ERR!   mirador@"*" from the root project
npm ERR!   peer mirador@"^3.0.0" from mirador-textoverlay@0.3.8
npm ERR!   node_modules/mirador-textoverlay
npm ERR!     mirador-textoverlay@"dbmdz/mirador-textoverlay#iiifv3" from the root project

I have tried to install it again but getting same errors without any flags.