v4.0.0.alpha-2

What's Changed

• Remove extra slash from import by @marlo-longley in #3894

Full Changelog: v4.0.0.alpha-1...v4.0.0.alpha-2

v4.0.0.alpha-1

Mirador v4 is a major refresh of many of the upstream dependencies of this project. Notably, Mirador v4 allows (and requires) downstream application use to React 18 and Material UI 5. Many other Mirador dependencies have been upgraded or replaced with modern equivalents. This alpha-1 prerelease is being made early to facilitate additional testing.

Mirador application developers are encouraged to read the (lengthy) Material UI 5 upgrade guide, React 18 upgrade guide, and review the commits below to see what changes were necessary in Mirador. A full upgrade guide will included in future Mirador release notes.

MUI 5

• Update @material-ui/core to 4.12 by @thatbudakguy in #3528
• Fix warnings related to Material UI updates by @dicksonlaw583 in #3476
• Fix MUI5 testing errors by @marlo-longley in #3793
• Fix some styling and console errors on mui5 branch by @marlo-longley in #3803
• Run CI tests when making PRs against the mui5 branch by @marlo-longley in #3794
• Rebased #3795 by @cbeer in #3804
• [MUI] Apply styles to the ToC nodes by @cbeer in #3811
• Restore spacing to the collection modal dialog by @cbeer in #3812
• [MUI5] Give the workspace add resource button a little spacing by @cbeer in #3810
• [MUI5] Add a custom background color for annotation + search chips in the gallery view by @cbeer in #3809
• [Mui5] Fix up companion window section styling by @cbeer in #3808
• [MUI5] Center collapse icon in the container by @cbeer in #3807
• [MUI5] Improve the window sidebar border by @cbeer in #3806
• Add docu for selectors by @fstoe in #3787
• [MUI5] Reduce Window top menu button margin by @cbeer in #3805
• [MUI5] Fix layer drag handle spacing by @cbeer in #3813
• Update CI to use current LTS node releases by @cbeer in #3817
• [MUI5] Restore auth banner colors by @cbeer in #3814
• [MUI5] Remove unnecessary value for boolean property by @cbeer in #3815
• [MUI5] Always give the title controls some space by @cbeer in #3816
• Use an explicit dom ref for handling scrolling to dom elements by @cbeer in #3819
• Remove unused classes propType by @marlo-longley in #3818
• Extract a styled CompanionWindowSection by @cbeer in #3820
• Create a MenuItem variant instead of using inline sx styles by @cbeer in #3823
• Use an MUI accordion for the sidebar collapsing sections by @cbeer in #3822
• Refactor WindowCanvasNavigationControls to pull stacking + alignment up by @cbeer in #3825
• Push IIIFThumbnail styling into slots + variants by @cbeer in #3824
• Pull button margins up to its container by @cbeer in #3828
• Create a Dialog variant to contain a modal within a mirador window by @cbeer in #3827
• Fix the CSS selector for restoring a focus state to the Fab by @cbeer in #3830
• Use MenuItem divider prop instead of styling it ourselves by @cbeer in #3829
• Refactor ErrorContent to use styled slots by @cbeer in #3826
• Remove unnecessary StyledMiradorMenuButton by @cbeer in #3832
• Extract WorkspaceDialog styles and push styling up to settings by @cbeer in #3833
• Pull SanitizedHtml styling up by @cbeer in #3836
• Pull workspace styles up by @cbeer in #3838
• Pull WorkspaceControlPanel styles up by @cbeer in #3839
• Pull WindowTopBar styles up by @cbeer in #3841
• Pull window options selection styles up by @cbeer in #3842
• Use Badge color instead of custom styling by @cbeer in #3843
• Pull companion area styling up by @cbeer in #3835
• Create a common selected style for mirador buttons by @cbeer in #3840
• Push companion window styles up to settings by @cbeer in #3834
• Remove apparently unused styles by @cbeer in #3845
• Fix ManifestListItem border state by @cbeer in #3846
• Remove unnecessary styling on cancel button by @cbeer in #3847
• Pull GalleryView styles up by @cbeer in #3848
• Pull window sidebar styles up by @cbeer in #3849
• The Fab ripple is what gives it a focused state; instead of disabling… by @cbeer in #3850
• Remove unnecessary button margin by @cbeer in #3853
• Style the workspace sidebar with flexbox by @cbeer in #3852
• Pull more styling up by @cbeer in #3851
• Continue to apply custom tooltip margins by @cbeer in #3855
• Mui5 sidebar list styles by @cbeer in #3854
• Pull Window styles up by @cbeer in #3837
• Restyle the WorkspaceExport form by @cbeer in #3831
• Fix branding alignment by @cbeer in #3856
• Fix dark mode issues with the collection dialog by @cbeer in #3857
• Wrap the empty workspace in paper to get the right background in dark… by @cbeer in #3858
• Update dependencies by @cbeer in #3860
• remove unused clsx dependency by @cbeer in #3861
• Update annotation tags to avoid improperly nested HTML tags by @cbeer in #3859
• Replace redux-devtools-extension with @redux-devtools/extension by @cbeer in #3863
• Remove deprecated @mui/styles package by @cbeer in #3862
• Upgrade from MUI4 to MUI5 [breaking changes] by @cbeer in #3648

React 17 + 18

• Remove enzyme by @cbeer in #3740
• Update to React 17 by @cbeer in #3741
• Update testing libraries by @cbeer in #3742
• Update to React 18 by @cbeer in #3864

Other dependency updates

• Update development dependencies and test with current versions of nodejs by @cbeer in #3547
• Update dependencies by @cbeer in #3591
• Update react-full-screen by @cbeer in #3605
• Replace @researchgate/react-intersection-observer with react-intersection-observer by @cbeer in #3608
• enableFetchMock by @jcoyne in #3619
• Stop using isomorphic-unfetch by @jcoyne in #3622
• Remove isomorphic-fetch dependency by @jcoyne in #3627
• Stop requiring polyfills by @jcoyne in #3612
• Update I18n libraries by @cbeer in #3609
• Use modern jsx transform approach by @cbeer in #3604
• Allow OSD 3.x and 4.x by @cbeer in #3635
• Update puppeteer by @cbeer in #3634
• Replace IComCom library with custom component by @marlo-longley in #3636
• Replace react-aria-live with @react-aria/live-announcer by @cbeer in #3610
• Update react-mosaic, react-dnd and related libraries by @cbeer in https://github.com/ProjectMirador/mirador/pull...

v3.3.0

What's Changed

• Give the collection modal content some padding; fixes #3434 by @cbeer in #3444
• Add whitespace between the seeAlso link and the mime type; fixes #3380 by @cbeer in #3445
• Wrap the export json in an accordion; fixes #3440 by @cbeer in #3443
• Pluralize item counts for English, at least; fixes #3268 by @cbeer in #3446
• Use an explicit placeholder for missing manifest thumbnails by @cbeer in #3447
• Update french translations per #3451 by @regisrob in #3452
• Add Mirador 2 maintenance status info by @camillevilla in #3455
• Respect the IIIF service preferredFormats list when picking thumbnails by @cbeer in #3442
• Increase the default elastic window size to 480x400 by @cbeer in #3460
• Update translation.json by @dvhassel in #3468
• Consolidate implementations of asArray by @cbeer in #3449
• Guard against missing canvas groupings by @cbeer in #3456
• Scroll the selected annotation into view in the annotations companion window by @cbeer in #3450
• Stop displaying 'added from url placeholder' by @cbeer in #3448
• Norwegian bokmål translation by @tarjelavik in #3474
• Do not import manifesto es modules directly by @charbugs in #3478
• point pkg.main to cjs modules by @charbugs in #3479
• Update manifest link by @DigitLib in #3490
• Update it locale by @atomotic in #3495
• Support for a polish (pl) locale by @tsuchodolskij in #3502
• Update fr translation of windowPluginMenu key by @regisrob in #3504
• Add Korean translation in src/locales by @typiespectre in #3505
• Release v3.3.0 by @cbeer in #3508

New Contributors

• @dvhassel made their first contribution in #3468
• @tarjelavik made their first contribution in #3474
• @tsuchodolskij made their first contribution in #3502
• @typiespectre made their first contribution in #3505

Full Changelog: v3.2.0...v3.3.0

v3.2.0

Commit History

Improvements

• Refactor MiradorViewer to be more amenable for use inside a React application
• #3432 Prevent item labels in the Collection modal from being cut off

Locales

• #3428 Add support for Swedish

Developer tooling

• #3415 add npm script for running the test suite in a debugger
• Update development dependencies

Thanks to:
@cbeer
@lutzhelm
@camillevilla
@regisrob
@charbugs
@istyf
@shestyf
@markmatney
@mejackreed

v3.1.1

Commit History

Bug Fixes

Unpin mirador icons

v3.1.0

Commit History

New Features and improvements

• #3386 Vietnamese translations added
• #3357 New config setting: Specify sidebar panel for a specific window

id: 'mirador',
  windows: [{
   manifestId: 'https://iiif.harvardartmuseums.org/manifests/object/299843',
   sideBarOpen: true,
   sideBarPanel: 'canvas',
  }],
  window: {
    sideBarPanel: 'info',
  }

• #3060 Show the search panel if there's a default search query
• Translation updates for Japanese (#3386), Serbian (#3359), Dutch(#3367), and German (#3390)
• #3411 Enable layers panel in default settings
• #3390 Improved support for paginated search responses
• #3391 Adds the option to disable automatic canvas switching upon receiving search results
• #3394 Improved thumbnail selection to prefer thumbnails offered by the manifest, even when the thumbnail is not a IIIF image
• #3379 Allows for configuration of <audio> and <video> element attributes enabling crossOrigin support for things like WebVTT caption

Bug Fixes

• #3343 Fixes an issue where clearing the search input for content search was broken
• #3347 Fix an issue with keyboard navigation in gallery view
• #3350 Fixes an issue where when displaying rights data, a <dl> tag was missing
• #3355 Fix some errors with the content search autocomplete dropdown
• #3360 Adds additional untranslated keys in the collection dialog
• #3374 Quotes instead of lowercasing section labels for non-English languages
• #3402 Fixes an issue where annotations can work without a target selector
• #3373 Update the plugin name for the WindowTopMenuButton widget

Upgrade Notes

• Plugin authors should take note of #3373, and connect plugins to WindowTopMenuButton not WindowTopMenuButtons

Thanks to:

@ggeisler
@jbaiter
@mejackreed
@cbeer
@boeschung
@morpheus-87
@DigitLib
@pbinkley
@lutzhelm
@knagasaki
Ngo Trung Viet
@markmatney
@camillevilla
@jkeck

v3.0.0

This release represents years of effort by a large group of individuals. Thank you to everyone who has provided use cases, bug reports, translations, analysis, and features to make Mirador 3 what it is today. This project would not be possible without such a broad contributor base.

Notable new features in Mirador 3 includes:

• Two distinct types of workspaces
• IIIF Presentation v2 and v3 support including Audio/Video resources
• Rich set of out-of-the-box configurations
• Themable with included light and dark themes
• Internationalized and available in 12 languages
• Designed and built with an accessibility focus
• Reduction in overall size by 60%
• Robust plugin framework enables additional customization
• Annotation creation support for W3C Web Annotations available in a plugin
• Plugins ready available for use: image tools, download, share, and annotations

There is not an upgrade path for existing Mirador 2 users, but Mirador 3 offers enhanced customization options we think Mirador adopters will be happy with.

More information available in:

• Project Readme
• Project website
• Wiki
• FAQ

v3.0.0-rc.7

v3.0.0-rc.6...v3.0.0-rc.7

Aims to be the final release candidate before the final Mirador 3 release.

Updates

#3262 - Refactoring components to avoid pulling in manifesto canvas objects where possible
#3257 - Allow plugin components to be given as react elements
#3261 - IIIF authentication display tweaks
#3277 - Adds Lithuanian translation
#3291 - Updates manifesto to v4.2.0 fixing metadata display in multiple languages
#3288 - Enhanced apis for generating classnames and tearing down a Mirador instance
#3290, #3249 - updates to initialize a collection by default
#3283 - Remove css loader
#3264 - Basic audio and video support

Fixes

#3260 - Don't autofocus the auth submit button
#3289 - Trust that we should fetch cookies or tokens over the ok-ness of item
#3266 - Support v3 style layers and targeted images

Thanks to everyone who contributed and reported issues!

v3.0.0-rc.6

v3.0.0-rc.5...v3.0.0-rc.6

Changes and new features

#3238 Allow target.source as a valid target
#3258 A large refactor of IIIF Auth for better flexibility and removing thunks
#3255 new issue templates

Fixes and cleanup

#3241 Fixes an issue where merge-recursively would cause problems

v3.0.0-rc.5

v3.0.0-rc.4...v3.0.0-rc.5

Changes and new features

#3222 Updates German translations
#3230 Adds layers panel to settings
#3026 Adds support for IIIF collections
#3232 Annotation enhancements needed to support multiple selectors and target sources
#3228 Enable plugins to provide their own configs that can get merged into config

Fixes and cleanup

#3219 Fixes a typo in auth handling
#3229 Fixes some accessibility issues
#3227 Remove unused plugin preprocessing