-
Notifications
You must be signed in to change notification settings - Fork 21
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
'Document list' component to replace downloads and articles, and use for search results #2011
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me. The only thing that I wonder about is the name of the component; i.e. Document
vs something like DocumentEntry
or DocumentItem
since the component presents information about a document rather than being the actual document.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just these few things, other than that looks good
Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com>
Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com>
…tem into 1797-search-result
Yeah I raised a bug for this #2024 |
…for search results (#2011) * added document component first draft * refector * added date * added more metadata options * corrected page template heading levels * added examples of differenet document types * added featured docs * fixed issues with examples * used new document component in news pattern * documentation * more documentation * fixed bug #1664 * replaced download resources with new document component * removed old components replaced by document * removed unnecessary change * removed unused document examples * revert unrelated changes * removed scss imports for removed components * removed old placeholder thumbnail pngs * removed unused imports from guide example * revert removed onsList from guide rtl example * macro options docs * refactored download resources pattern to use document list * fix for border and margin showing when preceded by hidden item * revert test * updated downloadable resources examples [test-visual] * remove bottom border from inline featured doc * changed name of component and fixed featured image size * updated example folder names * adjusted metadata line height * pr suggestion * Update src/components/document-list/_macro.njk Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com> * Update src/components/document-list/_macro.njk Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com> Co-authored-by: rmccar <42928680+rmccar@users.noreply.github.com>
Contains breaking changes
What is the context of this PR?
Created a new single 'document list' component to be used to display similar types of document links/excerpts. Intended for:
Each variant of this component contains:
What are the breaking changes?
Developers using the following patterns and components will need to replace them with the new
onsDocumentList()
macro.Removed components
The new 'document list' component replaces the now deprecated components:
Affected patterns
The following patterns are updated to now use the new 'document' component in replace of the deprecated components listed above:
Closes #1797 and fixes #1664
How to review
Check macro, documentation, variants and examples of the components and patterns listed above.