Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Small refactoring of Mirador configuration #2747

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

davide-negretti
Copy link
Contributor

@davide-negretti davide-negretti commented Jan 17, 2024

Description

This is a small refactoring of the Mirador configuration file

Before:

(Mirador.viewer(
    {
      // settings
    },
    [
      // list of plugins
    ]
  )
)(manifest);

After:

const miradorConfiguration = {
  // settings
}

const miradorPlugins = [
  // list of plugins
];

Mirador.viewer(miradorConfiguration, miradorPlugins);

This refactoring is useful in situations where the developer wants to make some settings or some plugins depend on a configuration variable

Note that manifest object was already provided as the data property of the settings object

Checklist

This checklist provides a reminder of what we are going to look for when reviewing your PR. You need not complete this checklist prior to creating your PR (draft PRs are always welcome). If you are unsure about an item in the checklist, don't hesitate to ask. We're here to help!

  • My PR is small in size (e.g. less than 1,000 lines of code, not including comments & specs/tests), or I have provided reasons as to why that's not possible.
  • My PR passes ESLint validation using yarn lint
  • My PR doesn't introduce circular dependencies (verified via yarn check-circ-deps)
  • My PR includes TypeDoc comments for all new (or modified) public methods and classes. It also includes TypeDoc for large or complex private methods.
  • My PR passes all specs/tests and includes new/updated specs or tests based on the Code Testing Guide.
  • If my PR includes new libraries/dependencies (in package.json), I've made sure their licenses align with the DSpace BSD License based on the Licensing of Contributions documentation.
  • If my PR includes new features or configurations, I've provided basic technical documentation in the PR itself.
  • If my PR fixes an issue ticket, I've linked them together.

@tdonohue tdonohue added code task integration: IIIF Related to International Image Interoperability Framework (IIIF) support labels Jan 17, 2024
@tdonohue tdonohue removed the request for review from artlowel March 21, 2024 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
code task integration: IIIF Related to International Image Interoperability Framework (IIIF) support
Projects
Status: 👀 Under Review
Development

Successfully merging this pull request may close these issues.

2 participants