-
Notifications
You must be signed in to change notification settings - Fork 147
feat(site): update doc-core to 1.22.0 #4946
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
base: main
Are you sure you want to change the base?
Changes from all commits
8abaf75
cd8f854
5554006
c88df04
7bd5431
fd169d2
ab7e423
9bd5791
442be1e
4a88713
3c7b2d3
e70b306
bb743dd
a3abcc2
2f23268
f6ec840
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -46,3 +46,5 @@ lerna-debug.log | |
| !.yarn/releases | ||
| !.yarn/sdks | ||
| !.yarn/versions | ||
|
|
||
| *.tsbuildinfo | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,78 +1 @@ | ||
| import React from "react"; | ||
|
|
||
| import './sectionGallery.css'; | ||
| import { SectionGalleryToolbar } from "./sectionGalleryToolbar"; | ||
| import { SectionGalleryLayout } from "./sectionGalleryLayout"; | ||
| import { SectionDataListLayout } from "./sectionDataListLayout"; | ||
| import { SectionGalleryWrapper } from "./sectionGalleryWrapper"; | ||
|
|
||
| /** | ||
| * Helper component returns gallery of items with search toolbar and switchable gallery/data list views. | ||
| * @param {Object} illustrations - Object of preview images mapped to their snake_case item display name | ||
| * @param {string} section - Name of the navigation section to create the gallery within | ||
| * @param {Object} galleryItemsData - Object containing the image location & summary text mapped to the gallery item's hyphenated-name | ||
| * @param {string} [placeholderText=Search by name] - Optional text to be displayed as placeholder for SearchInput | ||
| * @param {string} [countText= items] - Optional text to be displayed after the number of search results | ||
| * @param {string} [initialLayout=grid] - Optional text to indicate whether to default to grid or list layout | ||
| * @param {Boolean} [hasGridText=false] - Optional boolean to toggle text on grid layout cards | ||
| * @param {Boolean} [hasGridImages=false] - Optional boolean to toggle images on grid layout cards | ||
| * @param {Boolean} [hasListText=false] - Optional boolean to toggle text on list layout rows | ||
| * @param {Boolean} [hasListImages=false] - Optional boolean to toggle images on list layout rows | ||
| * @param {Boolean} [isFullWidth=true] - Optional boolean to disable component from exceeding default max-width for page | ||
| */ | ||
|
|
||
| export const SectionGallery = ({ | ||
| illustrations, | ||
| section, | ||
| subsection = null, | ||
| includeSubsections = false, | ||
| parseSubsections = false, | ||
| galleryItemsData, | ||
| placeholderText, | ||
| countText, | ||
| initialLayout = "grid", | ||
| hasGridText = false, | ||
| hasGridImages = true, | ||
| hasListText = true, | ||
| hasListImages = true, | ||
| isFullWidth = true, | ||
| onlyShowInGalleryData = false | ||
| }) => ( | ||
| <SectionGalleryWrapper | ||
| illustrations={illustrations} | ||
| section={section} | ||
| subsection={subsection} | ||
| includeSubsections={includeSubsections} | ||
| parseSubsections={parseSubsections} | ||
| galleryItemsData={galleryItemsData} | ||
| initialLayout={initialLayout} | ||
| isFullWidth={isFullWidth} | ||
| onlyShowInGalleryData={onlyShowInGalleryData} | ||
| > | ||
| {(sectionGalleryItems, searchTerm, setSearchTerm, layoutView, setLayoutView) => ( | ||
| <> | ||
| <SectionGalleryToolbar | ||
| galleryItems={sectionGalleryItems} | ||
| searchTerm={searchTerm} | ||
| setSearchTerm={setSearchTerm} | ||
| layoutView={layoutView} | ||
| setLayoutView={setLayoutView} | ||
| placeholderText={placeholderText} | ||
| countText={countText} | ||
| /> | ||
| <SectionGalleryLayout | ||
| galleryItems={sectionGalleryItems} | ||
| layoutView={layoutView} | ||
| hasGridText={hasGridText} | ||
| hasGridImages={hasGridImages} | ||
| /> | ||
| <SectionDataListLayout | ||
| galleryItems={sectionGalleryItems} | ||
| layoutView={layoutView} | ||
| hasListText={hasListText} | ||
| hasListImages={hasListImages} | ||
| /> | ||
| </> | ||
| )} | ||
| </SectionGalleryWrapper> | ||
| ); | ||
| export * from './sectionGallery.jsx'; |
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,78 @@ | ||
| import React from "react"; | ||
|
|
||
| import './sectionGallery.css'; | ||
| import { SectionGalleryToolbar } from "./sectionGalleryToolbar.jsx"; | ||
| import { SectionGalleryLayout } from "./sectionGalleryLayout.jsx"; | ||
| import { SectionDataListLayout } from "./sectionDataListLayout.jsx"; | ||
| import { SectionGalleryWrapper } from "./sectionGalleryWrapper.jsx"; | ||
|
|
||
| /** | ||
| * Helper component returns gallery of items with search toolbar and switchable gallery/data list views. | ||
| * @param {Object} illustrations - Object of preview images mapped to their snake_case item display name | ||
| * @param {string} section - Name of the navigation section to create the gallery within | ||
| * @param {Object} galleryItemsData - Object containing the image location & summary text mapped to the gallery item's hyphenated-name | ||
| * @param {string} [placeholderText=Search by name] - Optional text to be displayed as placeholder for SearchInput | ||
| * @param {string} [countText= items] - Optional text to be displayed after the number of search results | ||
| * @param {string} [initialLayout=grid] - Optional text to indicate whether to default to grid or list layout | ||
| * @param {Boolean} [hasGridText=false] - Optional boolean to toggle text on grid layout cards | ||
| * @param {Boolean} [hasGridImages=false] - Optional boolean to toggle images on grid layout cards | ||
| * @param {Boolean} [hasListText=false] - Optional boolean to toggle text on list layout rows | ||
| * @param {Boolean} [hasListImages=false] - Optional boolean to toggle images on list layout rows | ||
| * @param {Boolean} [isFullWidth=true] - Optional boolean to disable component from exceeding default max-width for page | ||
| */ | ||
|
|
||
| export const SectionGallery = ({ | ||
| illustrations, | ||
| section, | ||
| subsection = null, | ||
| includeSubsections = false, | ||
| parseSubsections = false, | ||
| galleryItemsData, | ||
| placeholderText, | ||
| countText, | ||
| initialLayout = "grid", | ||
| hasGridText = false, | ||
| hasGridImages = true, | ||
| hasListText = true, | ||
| hasListImages = true, | ||
| isFullWidth = true, | ||
| onlyShowInGalleryData = false | ||
| }) => ( | ||
| <SectionGalleryWrapper | ||
| illustrations={illustrations} | ||
| section={section} | ||
| subsection={subsection} | ||
| includeSubsections={includeSubsections} | ||
| parseSubsections={parseSubsections} | ||
| galleryItemsData={galleryItemsData} | ||
| initialLayout={initialLayout} | ||
| isFullWidth={isFullWidth} | ||
| onlyShowInGalleryData={onlyShowInGalleryData} | ||
| > | ||
| {(sectionGalleryItems, searchTerm, setSearchTerm, layoutView, setLayoutView) => ( | ||
| <> | ||
| <SectionGalleryToolbar | ||
| galleryItems={sectionGalleryItems} | ||
| searchTerm={searchTerm} | ||
| setSearchTerm={setSearchTerm} | ||
| layoutView={layoutView} | ||
| setLayoutView={setLayoutView} | ||
| placeholderText={placeholderText} | ||
| countText={countText} | ||
| /> | ||
| <SectionGalleryLayout | ||
| galleryItems={sectionGalleryItems} | ||
| layoutView={layoutView} | ||
| hasGridText={hasGridText} | ||
| hasGridImages={hasGridImages} | ||
| /> | ||
| <SectionDataListLayout | ||
| galleryItems={sectionGalleryItems} | ||
| layoutView={layoutView} | ||
| hasListText={hasListText} | ||
| hasListImages={hasListImages} | ||
| /> | ||
| </> | ||
| )} | ||
| </SectionGalleryWrapper> | ||
| ); |
This file was deleted.
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| --- | ||
| id: About us | ||
| title: About us | ||
| section: Get started | ||
|
Collaborator
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I don't think this should move to the Get started section. This is something that I believe Erin moved above the getting started section on staging on purpose
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Shoot, doing this would require another update in the doc core as it currently requires things to have a section
Collaborator
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think I've found a solution EDIT: I did not |
||
| --- | ||
|
|
||
| import './get-started/get-started.css'; | ||
|
|
||
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.
I don't understand why you'd be mixing import and require() in the same file
Uh oh!
There was an error while loading. Please reload this page.
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.
Because some of the files we're importing from are ESM and some are CJS