@patternfly/react-core 4.225.1 → 4.225.2

package/src/components/MultipleFileUpload/MultipleFileUploadMain.tsx

@@ -5,6 +5,9 @@ import { MultipleFileUploadTitle } from './MultipleFileUploadTitle';
 import { MultipleFileUploadButton } from './MultipleFileUploadButton';
 import { MultipleFileUploadInfo } from './MultipleFileUploadInfo';
 
+/** Creates the visual upload interface, including the area to drag and drop files,
+ * an optional upload button, and descriptive instructions.
+ */
 export interface MultipleFileUploadMainProps extends React.HTMLProps<HTMLDivElement> {
   /** Class to add to outer div */
   className?: string;

package/src/components/MultipleFileUpload/MultipleFileUploadStatus.tsx

@@ -6,6 +6,12 @@ import InProgressIcon from '@patternfly/react-icons/dist/esm/icons/in-progress-i
 import CheckCircleIcon from '@patternfly/react-icons/dist/esm/icons/check-circle-icon';
 import TimesCircleIcon from '@patternfly/react-icons/dist/esm/icons/times-circle-icon';
 
+/** Acts as an expandable container for all uploaded file statuses.
+ * An optional text and/or icon can also be passed into this sub-component.
+ * This sub-component can be conditionally rendered when at least 1 file has been
+ * attempted to be uploaded.
+ */
+
 export interface MultipleFileUploadStatusProps extends React.HTMLProps<HTMLDivElement> {
   /** Content rendered inside multi file upload status list */
   children?: React.ReactNode;

package/src/components/MultipleFileUpload/MultipleFileUploadStatusItem.tsx

@@ -6,6 +6,11 @@ import { Button } from '../Button';
 import FileIcon from '@patternfly/react-icons/dist/esm/icons/file-icon';
 import TimesCircleIcon from '@patternfly/react-icons/dist/esm/icons/times-circle-icon';
 
+/** Automatically reads an uploaded file to render a visual representation of it, including
+ * its name, size, and read status. This sub-component also allows custom reading of files
+ * via various callbacks which will override the automatic reading behavior.
+ */
+
 export interface MultipleFileUploadStatusItemProps extends React.HTMLProps<HTMLLIElement> {
   /** Class to add to outer div */
   className?: string;

package/src/components/MultipleFileUpload/examples/MultipleFileUpload.md

@@ -3,12 +3,7 @@ id: File upload - multiple
 section: components
 cssPrefix: pf-c-multiple-file-upload
 propComponents:
-  [
-    'MultipleFileUpload',
-    'MultipleFileUploadMain',
-    'MultipleFileUploadStatus',
-    'MultipleFileUploadStatusItem',
-  ]
+  ['MultipleFileUpload', 'MultipleFileUploadMain', 'MultipleFileUploadStatus', 'MultipleFileUploadStatusItem']
 beta: true
 ---
 
@@ -31,6 +26,19 @@ As with singular file upload, any [props accepted by react-dropzone's Dropzone c
 
 Restricting file sizes and types in this way is for user convenience only, and it cannot prevent a malicious user from submitting anything to your server. As with any user input, your application should also validate, sanitize and/or reject restricted files on the server side.
 
+## Composable structure
+
+File upload - multiple is designed in a composable manner to make customization easier. The standard sub-component relationships are arranged as follows:
+
+```noLive
+<MultipleFileUpload>
+  <MultipleFileUploadMain />
+  <MultipleFileUploadStatus>
+    <MultipleFileUploadStatusItem />
+  </MultipleFileUploadStatus>
+</MultipleFileUpload>
+```
+
 ## Examples
 
 ### Basic