XUL -> JS tree megacommit
- Just a single huge commit. This has been developed over too long a
time, required many tiny changes across too many files and has seen too
many iterations to be separated into separate commits.
The original branch with all the messy commits will be kept around for
posterity
https://github.com/zotero/zotero/compare/bb220ad0f2d6bf0eca6df6d225d3d358cb50a27b...adomasven:feature/react-item-tree
- Replaces XUL <tree> element across the whole zotero client codebase
with a custom supermegafast virtualized-table inspired by
react-virtualized yet mimicking old XUL treeview API. The
virtualized-table sits on top on a raw-to-the-metal,
interpreted-at-runtime JS based windowing solution inspired by
react-window. React-based solutions could not be used because they were
slow and Zotero UI needs to be responsive and be able to
display thousands of rows in a treeview without any slowdowns.
- Attempts were made at making this screen-reader friendly, but yet to
be tested with something like JAWS
- RTL-friendly
- Styling and behaviour across all platforms was copied as closely as
possible to the original XUL tree
- Instead of row-based scroll snapping this has smooth-scrolling. If
you're using arrow keys to browse through the tree then it effectively
snap-scrolls. Current CSS snap scroll attributes do not seem to work in
the way we would require even on up-to-date browsers, yet alone the ESR
version of FX that Zotero is on. JS solutions are either terrible for
performance or produce inexcusable jitter.
- When dragging-and-dropping items the initial drag freezes the UI for
a fairly jarring amount of time. Does not seem to be fixable due to
the synchronous code that needs to be run in the dragstart handler.
Used to be possible to run that code async with the XUL tree.
- Item tree column picker no longer has a dedicated button. Just
right-click the columns. The column preferences (width, order, etc) are
no longer handled by XUL, which required a custom serialization and
storage solution that throws warnings in the developer console due to
the amount of data being stored. Might cause temporary freezing on HDDs
upon column resize/reorder/visibility toggling.
- Context menu handling code basically unchanged, but any UI changes
that plugins may have wanted to do (including adding new columns) will
have to be redone by them. No serious thought has gone into how plugin
developers would achieve that yet.
- Opens up the possibility for awesome alternative ways to render the
tree items, including things like multiple-row view for the item tree,
which has been requested for a long while especially by users switching
from other referencing software
2020-06-03 07:29:46 +00:00
|
|
|
/*
|
|
|
|
|
***** BEGIN LICENSE BLOCK *****
|
|
|
|
|
|
2021-04-09 09:00:34 +00:00
|
|
|
Copyright © 2020 Corporation for Digital Scholarship
|
|
|
|
|
Vienna, Virginia, USA
|
XUL -> JS tree megacommit
- Just a single huge commit. This has been developed over too long a
time, required many tiny changes across too many files and has seen too
many iterations to be separated into separate commits.
The original branch with all the messy commits will be kept around for
posterity
https://github.com/zotero/zotero/compare/bb220ad0f2d6bf0eca6df6d225d3d358cb50a27b...adomasven:feature/react-item-tree
- Replaces XUL <tree> element across the whole zotero client codebase
with a custom supermegafast virtualized-table inspired by
react-virtualized yet mimicking old XUL treeview API. The
virtualized-table sits on top on a raw-to-the-metal,
interpreted-at-runtime JS based windowing solution inspired by
react-window. React-based solutions could not be used because they were
slow and Zotero UI needs to be responsive and be able to
display thousands of rows in a treeview without any slowdowns.
- Attempts were made at making this screen-reader friendly, but yet to
be tested with something like JAWS
- RTL-friendly
- Styling and behaviour across all platforms was copied as closely as
possible to the original XUL tree
- Instead of row-based scroll snapping this has smooth-scrolling. If
you're using arrow keys to browse through the tree then it effectively
snap-scrolls. Current CSS snap scroll attributes do not seem to work in
the way we would require even on up-to-date browsers, yet alone the ESR
version of FX that Zotero is on. JS solutions are either terrible for
performance or produce inexcusable jitter.
- When dragging-and-dropping items the initial drag freezes the UI for
a fairly jarring amount of time. Does not seem to be fixable due to
the synchronous code that needs to be run in the dragstart handler.
Used to be possible to run that code async with the XUL tree.
- Item tree column picker no longer has a dedicated button. Just
right-click the columns. The column preferences (width, order, etc) are
no longer handled by XUL, which required a custom serialization and
storage solution that throws warnings in the developer console due to
the amount of data being stored. Might cause temporary freezing on HDDs
upon column resize/reorder/visibility toggling.
- Context menu handling code basically unchanged, but any UI changes
that plugins may have wanted to do (including adding new columns) will
have to be redone by them. No serious thought has gone into how plugin
developers would achieve that yet.
- Opens up the possibility for awesome alternative ways to render the
tree items, including things like multiple-row view for the item tree,
which has been requested for a long while especially by users switching
from other referencing software
2020-06-03 07:29:46 +00:00
|
|
|
http://zotero.org
|
|
|
|
|
|
|
|
|
|
This file is part of Zotero.
|
|
|
|
|
|
|
|
|
|
Zotero is free software: you can redistribute it and/or modify
|
|
|
|
|
it under the terms of the GNU Affero General Public License as published by
|
|
|
|
|
the Free Software Foundation, either version 3 of the License, or
|
|
|
|
|
(at your option) any later version.
|
|
|
|
|
|
|
|
|
|
Zotero is distributed in the hope that it will be useful,
|
|
|
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
|
GNU Affero General Public License for more details.
|
|
|
|
|
|
|
|
|
|
You should have received a copy of the GNU Affero General Public License
|
|
|
|
|
along with Zotero. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
|
|
|
|
|
|
***** END LICENSE BLOCK *****
|
|
|
|
|
*/
|
|
|
|
|
|
|
|
|
|
(function() {
|
|
|
|
|
const React = require('react');
|
|
|
|
|
const Icons = require('components/icons');
|
|
|
|
|
|
2021-08-26 13:16:44 +00:00
|
|
|
/**
|
|
|
|
|
* @type Column {
|
|
|
|
|
* dataKey: string, // Required, see use in ItemTree#_getRowData()
|
|
|
|
|
*
|
|
|
|
|
* defaultIn: Set<string>, // Types of trees the column is default in. Can be [default, feed];
|
|
|
|
|
* disabledIn: Set<string>, // Types of trees where the column is not available
|
|
|
|
|
*
|
|
|
|
|
* flex: number, // Default: 1. When the column is added to the tree how much space it should occupy as a flex ratio
|
|
|
|
|
* width: string, // A column width instead of flex ratio. See above.
|
|
|
|
|
* fixedWidth: boolean // Default: false. Set to true to disable column resizing
|
|
|
|
|
*
|
|
|
|
|
* label: string, // The column label. Either a string or the id to an i18n string.
|
|
|
|
|
* iconLabel: React.Component, // Set an Icon label instead of a text-based one
|
|
|
|
|
*
|
|
|
|
|
* ignoreInColumnPicker: boolean // Default: false. Set to true to not display in column picker.
|
|
|
|
|
* submenu: boolean, // Default: false. Set to true to display the column in "More Columns" submenu of column picker.
|
|
|
|
|
*
|
|
|
|
|
* primary: boolean, // Should only be one column at the time. Title is the primary column
|
|
|
|
|
* zoteroPersist: Set<string>, // Which column properties should be persisted between zotero close
|
|
|
|
|
* }
|
|
|
|
|
*/
|
XUL -> JS tree megacommit
- Just a single huge commit. This has been developed over too long a
time, required many tiny changes across too many files and has seen too
many iterations to be separated into separate commits.
The original branch with all the messy commits will be kept around for
posterity
https://github.com/zotero/zotero/compare/bb220ad0f2d6bf0eca6df6d225d3d358cb50a27b...adomasven:feature/react-item-tree
- Replaces XUL <tree> element across the whole zotero client codebase
with a custom supermegafast virtualized-table inspired by
react-virtualized yet mimicking old XUL treeview API. The
virtualized-table sits on top on a raw-to-the-metal,
interpreted-at-runtime JS based windowing solution inspired by
react-window. React-based solutions could not be used because they were
slow and Zotero UI needs to be responsive and be able to
display thousands of rows in a treeview without any slowdowns.
- Attempts were made at making this screen-reader friendly, but yet to
be tested with something like JAWS
- RTL-friendly
- Styling and behaviour across all platforms was copied as closely as
possible to the original XUL tree
- Instead of row-based scroll snapping this has smooth-scrolling. If
you're using arrow keys to browse through the tree then it effectively
snap-scrolls. Current CSS snap scroll attributes do not seem to work in
the way we would require even on up-to-date browsers, yet alone the ESR
version of FX that Zotero is on. JS solutions are either terrible for
performance or produce inexcusable jitter.
- When dragging-and-dropping items the initial drag freezes the UI for
a fairly jarring amount of time. Does not seem to be fixable due to
the synchronous code that needs to be run in the dragstart handler.
Used to be possible to run that code async with the XUL tree.
- Item tree column picker no longer has a dedicated button. Just
right-click the columns. The column preferences (width, order, etc) are
no longer handled by XUL, which required a custom serialization and
storage solution that throws warnings in the developer console due to
the amount of data being stored. Might cause temporary freezing on HDDs
upon column resize/reorder/visibility toggling.
- Context menu handling code basically unchanged, but any UI changes
that plugins may have wanted to do (including adding new columns) will
have to be redone by them. No serious thought has gone into how plugin
developers would achieve that yet.
- Opens up the possibility for awesome alternative ways to render the
tree items, including things like multiple-row view for the item tree,
which has been requested for a long while especially by users switching
from other referencing software
2020-06-03 07:29:46 +00:00
|
|
|
const COLUMNS = [
|
|
|
|
|
{
|
|
|
|
|
dataKey: "title",
|
|
|
|
|
primary: true,
|
|
|
|
|
defaultIn: new Set(["default", "feed"]),
|
|
|
|
|
label: "zotero.items.title_column",
|
2021-08-26 13:16:44 +00:00
|
|
|
ignoreInColumnPicker: true,
|
XUL -> JS tree megacommit
- Just a single huge commit. This has been developed over too long a
time, required many tiny changes across too many files and has seen too
many iterations to be separated into separate commits.
The original branch with all the messy commits will be kept around for
posterity
https://github.com/zotero/zotero/compare/bb220ad0f2d6bf0eca6df6d225d3d358cb50a27b...adomasven:feature/react-item-tree
- Replaces XUL <tree> element across the whole zotero client codebase
with a custom supermegafast virtualized-table inspired by
react-virtualized yet mimicking old XUL treeview API. The
virtualized-table sits on top on a raw-to-the-metal,
interpreted-at-runtime JS based windowing solution inspired by
react-window. React-based solutions could not be used because they were
slow and Zotero UI needs to be responsive and be able to
display thousands of rows in a treeview without any slowdowns.
- Attempts were made at making this screen-reader friendly, but yet to
be tested with something like JAWS
- RTL-friendly
- Styling and behaviour across all platforms was copied as closely as
possible to the original XUL tree
- Instead of row-based scroll snapping this has smooth-scrolling. If
you're using arrow keys to browse through the tree then it effectively
snap-scrolls. Current CSS snap scroll attributes do not seem to work in
the way we would require even on up-to-date browsers, yet alone the ESR
version of FX that Zotero is on. JS solutions are either terrible for
performance or produce inexcusable jitter.
- When dragging-and-dropping items the initial drag freezes the UI for
a fairly jarring amount of time. Does not seem to be fixable due to
the synchronous code that needs to be run in the dragstart handler.
Used to be possible to run that code async with the XUL tree.
- Item tree column picker no longer has a dedicated button. Just
right-click the columns. The column preferences (width, order, etc) are
no longer handled by XUL, which required a custom serialization and
storage solution that throws warnings in the developer console due to
the amount of data being stored. Might cause temporary freezing on HDDs
upon column resize/reorder/visibility toggling.
- Context menu handling code basically unchanged, but any UI changes
that plugins may have wanted to do (including adding new columns) will
have to be redone by them. No serious thought has gone into how plugin
developers would achieve that yet.
- Opens up the possibility for awesome alternative ways to render the
tree items, including things like multiple-row view for the item tree,
which has been requested for a long while especially by users switching
from other referencing software
2020-06-03 07:29:46 +00:00
|
|
|
flex: 4,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "firstCreator",
|
|
|
|
|
defaultIn: new Set(["default", "feed"]),
|
|
|
|
|
label: "zotero.items.creator_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "itemType",
|
|
|
|
|
label: "zotero.items.type_column",
|
|
|
|
|
width: "40",
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "date",
|
|
|
|
|
defaultIn: new Set(["feed"]),
|
|
|
|
|
label: "zotero.items.date_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "year",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.items.year_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "publisher",
|
|
|
|
|
label: "zotero.items.publisher_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "publicationTitle",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.items.publication_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "journalAbbreviation",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.journalAbbr_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "language",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.language_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "accessDate",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.accessDate_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "libraryCatalog",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.libraryCatalog_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "callNumber",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.callNumber_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "rights",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.rights_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "dateAdded",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.items.dateAdded_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "dateModified",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.items.dateModified_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "archive",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.archive_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "archiveLocation",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.archiveLocation_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "place",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.place_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "volume",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.volume_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "edition",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.edition_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "pages",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.pages_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "issue",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.issue_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "series",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.series_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "seriesTitle",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.seriesTitle_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "court",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.court_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "medium",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.medium_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "genre",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.genre_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "system",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
submenu: true,
|
|
|
|
|
label: "zotero.items.system_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "extra",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.items.extra_column",
|
|
|
|
|
flex: 1,
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "hasAttachment",
|
|
|
|
|
defaultIn: new Set(["default"]),
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.tabs.attachments.label",
|
|
|
|
|
iconLabel: <Icons.IconAttachSmall />,
|
|
|
|
|
fixedWidth: true,
|
|
|
|
|
width: "14",
|
|
|
|
|
zoteroPersist: new Set(["hidden", "sortDirection"])
|
|
|
|
|
},
|
|
|
|
|
{
|
|
|
|
|
dataKey: "numNotes",
|
|
|
|
|
disabledIn: "feed",
|
|
|
|
|
label: "zotero.tabs.notes.label",
|
|
|
|
|
iconLabel: <Icons.IconTreeitemNoteSmall />,
|
|
|
|
|
width: "14",
|
|
|
|
|
zoteroPersist: new Set(["width", "hidden", "sortDirection"])
|
|
|
|
|
}
|
|
|
|
|
];
|
|
|
|
|
|
|
|
|
|
function getDefaultColumnByDataKey(dataKey) {
|
2021-08-26 13:16:44 +00:00
|
|
|
return Object.assign({}, COLUMNS.find(col => col.dataKey == dataKey), {hidden: false});
|
XUL -> JS tree megacommit
- Just a single huge commit. This has been developed over too long a
time, required many tiny changes across too many files and has seen too
many iterations to be separated into separate commits.
The original branch with all the messy commits will be kept around for
posterity
https://github.com/zotero/zotero/compare/bb220ad0f2d6bf0eca6df6d225d3d358cb50a27b...adomasven:feature/react-item-tree
- Replaces XUL <tree> element across the whole zotero client codebase
with a custom supermegafast virtualized-table inspired by
react-virtualized yet mimicking old XUL treeview API. The
virtualized-table sits on top on a raw-to-the-metal,
interpreted-at-runtime JS based windowing solution inspired by
react-window. React-based solutions could not be used because they were
slow and Zotero UI needs to be responsive and be able to
display thousands of rows in a treeview without any slowdowns.
- Attempts were made at making this screen-reader friendly, but yet to
be tested with something like JAWS
- RTL-friendly
- Styling and behaviour across all platforms was copied as closely as
possible to the original XUL tree
- Instead of row-based scroll snapping this has smooth-scrolling. If
you're using arrow keys to browse through the tree then it effectively
snap-scrolls. Current CSS snap scroll attributes do not seem to work in
the way we would require even on up-to-date browsers, yet alone the ESR
version of FX that Zotero is on. JS solutions are either terrible for
performance or produce inexcusable jitter.
- When dragging-and-dropping items the initial drag freezes the UI for
a fairly jarring amount of time. Does not seem to be fixable due to
the synchronous code that needs to be run in the dragstart handler.
Used to be possible to run that code async with the XUL tree.
- Item tree column picker no longer has a dedicated button. Just
right-click the columns. The column preferences (width, order, etc) are
no longer handled by XUL, which required a custom serialization and
storage solution that throws warnings in the developer console due to
the amount of data being stored. Might cause temporary freezing on HDDs
upon column resize/reorder/visibility toggling.
- Context menu handling code basically unchanged, but any UI changes
that plugins may have wanted to do (including adding new columns) will
have to be redone by them. No serious thought has gone into how plugin
developers would achieve that yet.
- Opens up the possibility for awesome alternative ways to render the
tree items, including things like multiple-row view for the item tree,
which has been requested for a long while especially by users switching
from other referencing software
2020-06-03 07:29:46 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
|
|
function getDefaultColumnsByDataKeys(dataKeys) {
|
|
|
|
|
return COLUMNS.filter(column => dataKeys.includes(column.dataKey)).map(column => Object.assign({}, column, {hidden: false}));
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
module.exports = {
|
|
|
|
|
COLUMNS,
|
|
|
|
|
getDefaultColumnByDataKey,
|
|
|
|
|
getDefaultColumnsByDataKeys,
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
})();
|