@cloudscape-design/board-components 3.0.0

package/Config

@@ -0,0 +1,23 @@
+package.AWS-UI-Board-Components = {
+  interfaces = (3.0);
+
+  build-system = npm-pretty-much;
+  build-tools = {
+      3.0 = {
+          NpmPrettyMuch = 1.1;
+          NodeJS = default;
+      };
+  };
+
+  dependencies = {
+      3.0 = {
+          AWS-UI-Component-Toolkit = 1.0;
+      };
+  };
+
+  test-dependencies = {
+      3.0 = {
+          AWS-UI-ReleaseTools = 3.0;
+      };
+  };
+};

package/LICENSE

@@ -0,0 +1,201 @@
+Apache License
+Version 2.0, January 2004
+http://www.apache.org/licenses/
+
+TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+1. Definitions.
+
+"License" shall mean the terms and conditions for use, reproduction,
+and distribution as defined by Sections 1 through 9 of this document.
+
+"Licensor" shall mean the copyright owner or entity authorized by
+the copyright owner that is granting the License.
+
+"Legal Entity" shall mean the union of the acting entity and all
+other entities that control, are controlled by, or are under common
+control with that entity. For the purposes of this definition,
+"control" means (i) the power, direct or indirect, to cause the
+direction or management of such entity, whether by contract or
+otherwise, or (ii) ownership of fifty percent (50%) or more of the
+outstanding shares, or (iii) beneficial ownership of such entity.
+
+"You" (or "Your") shall mean an individual or Legal Entity
+exercising permissions granted by this License.
+
+"Source" form shall mean the preferred form for making modifications,
+including but not limited to software source code, documentation
+source, and configuration files.
+
+"Object" form shall mean any form resulting from mechanical
+transformation or translation of a Source form, including but
+not limited to compiled object code, generated documentation,
+and conversions to other media types.
+
+"Work" shall mean the work of authorship, whether in Source or
+Object form, made available under the License, as indicated by a
+copyright notice that is included in or attached to the work
+(an example is provided in the Appendix below).
+
+"Derivative Works" shall mean any work, whether in Source or Object
+form, that is based on (or derived from) the Work and for which the
+editorial revisions, annotations, elaborations, or other modifications
+represent, as a whole, an original work of authorship. For the purposes
+of this License, Derivative Works shall not include works that remain
+separable from, or merely link (or bind by name) to the interfaces of,
+the Work and Derivative Works thereof.
+
+"Contribution" shall mean any work of authorship, including
+the original version of the Work and any modifications or additions
+to that Work or Derivative Works thereof, that is intentionally
+submitted to Licensor for inclusion in the Work by the copyright owner
+or by an individual or Legal Entity authorized to submit on behalf of
+the copyright owner. For the purposes of this definition, "submitted"
+means any form of electronic, verbal, or written communication sent
+to the Licensor or its representatives, including but not limited to
+communication on electronic mailing lists, source code control systems,
+and issue tracking systems that are managed by, or on behalf of, the
+Licensor for the purpose of discussing and improving the Work, but
+excluding communication that is conspicuously marked or otherwise
+designated in writing by the copyright owner as "Not a Contribution."
+
+"Contributor" shall mean Licensor and any individual or Legal Entity
+on behalf of whom a Contribution has been received by Licensor and
+subsequently incorporated within the Work.
+
+2. Grant of Copyright License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+copyright license to reproduce, prepare Derivative Works of,
+publicly display, publicly perform, sublicense, and distribute the
+Work and such Derivative Works in Source or Object form.
+
+3. Grant of Patent License. Subject to the terms and conditions of
+this License, each Contributor hereby grants to You a perpetual,
+worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+(except as stated in this section) patent license to make, have made,
+use, offer to sell, sell, import, and otherwise transfer the Work,
+where such license applies only to those patent claims licensable
+by such Contributor that are necessarily infringed by their
+Contribution(s) alone or by combination of their Contribution(s)
+with the Work to which such Contribution(s) was submitted. If You
+institute patent litigation against any entity (including a
+cross-claim or counterclaim in a lawsuit) alleging that the Work
+or a Contribution incorporated within the Work constitutes direct
+or contributory patent infringement, then any patent licenses
+granted to You under this License for that Work shall terminate
+as of the date such litigation is filed.
+
+4. Redistribution. You may reproduce and distribute copies of the
+Work or Derivative Works thereof in any medium, with or without
+modifications, and in Source or Object form, provided that You
+meet the following conditions:
+
+(a) You must give any other recipients of the Work or
+Derivative Works a copy of this License; and
+
+(b) You must cause any modified files to carry prominent notices
+stating that You changed the files; and
+
+(c) You must retain, in the Source form of any Derivative Works
+that You distribute, all copyright, patent, trademark, and
+attribution notices from the Source form of the Work,
+excluding those notices that do not pertain to any part of
+the Derivative Works; and
+
+(d) If the Work includes a "NOTICE" text file as part of its
+distribution, then any Derivative Works that You distribute must
+include a readable copy of the attribution notices contained
+within such NOTICE file, excluding those notices that do not
+pertain to any part of the Derivative Works, in at least one
+of the following places: within a NOTICE text file distributed
+as part of the Derivative Works; within the Source form or
+documentation, if provided along with the Derivative Works; or,
+within a display generated by the Derivative Works, if and
+wherever such third-party notices normally appear. The contents
+of the NOTICE file are for informational purposes only and
+do not modify the License. You may add Your own attribution
+notices within Derivative Works that You distribute, alongside
+or as an addendum to the NOTICE text from the Work, provided
+that such additional attribution notices cannot be construed
+as modifying the License.
+
+You may add Your own copyright statement to Your modifications and
+may provide additional or different license terms and conditions
+for use, reproduction, or distribution of Your modifications, or
+for any such Derivative Works as a whole, provided Your use,
+reproduction, and distribution of the Work otherwise complies with
+the conditions stated in this License.
+
+5. Submission of Contributions. Unless You explicitly state otherwise,
+any Contribution intentionally submitted for inclusion in the Work
+by You to the Licensor shall be under the terms and conditions of
+this License, without any additional terms or conditions.
+Notwithstanding the above, nothing herein shall supersede or modify
+the terms of any separate license agreement you may have executed
+with Licensor regarding such Contributions.
+
+6. Trademarks. This License does not grant permission to use the trade
+names, trademarks, service marks, or product names of the Licensor,
+except as required for reasonable and customary use in describing the
+origin of the Work and reproducing the content of the NOTICE file.
+
+7. Disclaimer of Warranty. Unless required by applicable law or
+agreed to in writing, Licensor provides the Work (and each
+Contributor provides its Contributions) on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+implied, including, without limitation, any warranties or conditions
+of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+PARTICULAR PURPOSE. You are solely responsible for determining the
+appropriateness of using or redistributing the Work and assume any
+risks associated with Your exercise of permissions under this License.
+
+8. Limitation of Liability. In no event and under no legal theory,
+whether in tort (including negligence), contract, or otherwise,
+unless required by applicable law (such as deliberate and grossly
+negligent acts) or agreed to in writing, shall any Contributor be
+liable to You for damages, including any direct, indirect, special,
+incidental, or consequential damages of any character arising as a
+result of this License or out of the use or inability to use the
+Work (including but not limited to damages for loss of goodwill,
+work stoppage, computer failure or malfunction, or any and all
+other commercial damages or losses), even if such Contributor
+has been advised of the possibility of such damages.
+
+9. Accepting Warranty or Additional Liability. While redistributing
+the Work or Derivative Works thereof, You may choose to offer,
+and charge a fee for, acceptance of support, warranty, indemnity,
+or other liability obligations and/or rights consistent with this
+License. However, in accepting such obligations, You may act only
+on Your own behalf and on Your sole responsibility, not on behalf
+of any other Contributor, and only if You agree to indemnify,
+defend, and hold each Contributor harmless for any liability
+incurred by, or claims asserted against, such Contributor by reason
+of your accepting any such warranty or additional liability.
+
+END OF TERMS AND CONDITIONS
+
+APPENDIX: How to apply the Apache License to your work.
+
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]"
+replaced with your own identifying information. (Don't include
+the brackets!)  The text should be enclosed in the appropriate
+comment syntax for the file format. We also recommend that a
+file or class name and description of purpose be included on the
+same "printed page" as the copyright notice for easier
+identification within third-party archives.
+
+Copyright [yyyy] [name of copyright owner]
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

package/NOTICE

@@ -0,0 +1,2 @@
+@cloudscape-design/board-components
+Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. 

package/README-cloudscape.md

@@ -0,0 +1,20 @@
+## React components for Cloudscape Design System
+
+This package contains the source code of dashboard-oriented components in the [Cloudscape Design System](https://cloudscape.design/).
+For more information about board components, see [the documentation](todo).
+
+Cloudscape is an open source design system for building intuitive, engaging, and inclusive user experiences at scale. It consists of an extensive set of guidelines to create web applications, along with the design resources and front-end components to streamline implementation.
+
+Cloudscape was built for and is used by Amazon Web Services (AWS) products and services. We created it in 2016 to improve the user experience across AWS web applications, and also to help teams implement those applications faster. Since then, we have continued enhancing the system based on customer feedback and research.
+
+## Getting help
+
+You can [create bug reports or feature requests](https://github.com/cloudscape-design/board-components/issues/new/choose), or [start a discussion](https://github.com/cloudscape-design/components/discussions) to ask a question. To minimize duplicates, we recommend that you search for existing bug reports, feature requests, or discussions before initiating a new thread.
+
+## Contributing
+
+The [contribution guidelines](/CONTRIBUTING.md) contains information on how to contribute, as well as our support model and versioning strategy.
+
+## License
+
+This project is licensed under the [Apache 2.0 License](/LICENSE).

package/README.md

@@ -0,0 +1,20 @@
+## React components for Cloudscape Design System
+
+This package contains the source code of dashboard-oriented components in the [Cloudscape Design System](https://cloudscape.design/).
+For more information about board components, see [the documentation](todo).
+
+Cloudscape is an open source design system for building intuitive, engaging, and inclusive user experiences at scale. It consists of an extensive set of guidelines to create web applications, along with the design resources and front-end components to streamline implementation.
+
+Cloudscape was built for and is used by Amazon Web Services (AWS) products and services. We created it in 2016 to improve the user experience across AWS web applications, and also to help teams implement those applications faster. Since then, we have continued enhancing the system based on customer feedback and research.
+
+## Getting help
+
+You can [create bug reports or feature requests](https://github.com/cloudscape-design/board-components/issues/new/choose), or [start a discussion](https://github.com/cloudscape-design/components/discussions) to ask a question. To minimize duplicates, we recommend that you search for existing bug reports, feature requests, or discussions before initiating a new thread.
+
+## Contributing
+
+The [contribution guidelines](/CONTRIBUTING.md) contains information on how to contribute, as well as our support model and versioning strategy.
+
+## License
+
+This project is licensed under the [Apache 2.0 License](/LICENSE).

package/board/index.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import type { BoardProps } from "./interfaces";
+export type { BoardProps };
+export default function Board<DataType>(props: BoardProps<DataType>): JSX.Element;

package/board/index.js

@@ -0,0 +1,11 @@
+import { jsx as _jsx } from "react/jsx-runtime";
+// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
+// SPDX-License-Identifier: Apache-2.0
+import useBaseComponent from "../internal/base-component/use-base-component";
+import { applyDisplayName } from "../internal/utils/apply-display-name";
+import { InternalBoard } from "./internal";
+export default function Board(props) {
+    const baseComponentProps = useBaseComponent("Board");
+    return _jsx(InternalBoard, { ...props, ...baseComponentProps });
+}
+applyDisplayName(Board, "Board");

package/board/interfaces.d.ts

@@ -0,0 +1,167 @@
+import { ReactNode } from "react";
+import { InteractionType, Operation } from "../internal/dnd-controller/controller";
+import { BoardItemDefinition, BoardItemDefinitionBase, DataFallbackType, Direction, GridLayout, GridLayoutItem, ItemId } from "../internal/interfaces";
+import { LayoutShift } from "../internal/layout-engine/interfaces";
+import { NonCancelableEventHandler } from "../internal/utils/events";
+import { Position } from "../internal/utils/position";
+export interface BoardProps<D = DataFallbackType> {
+    /**
+     * Specifies the items displayed in the board. Each item includes its position on the board and
+     * optional data. The content of an item is controlled by the `renderItem` property.
+     *
+     * The BoardProps.Item includes:
+     * * `id` (string) - the unique item identifier. The IDs of any two items in a page must be different.
+     * * `definition.minRowSpan` (number, optional) - the minimal number of rows the item is allowed to take. It can't be less than two. Defaults to two.
+     * * `definition.minColumnSpan` (number, optional) - the minimal number of columns the item is allowed to take. It can't be less than one. Defaults to one.
+     * * `definition.defaultRowSpan` (number, optional) - the number or rows the item will take when inserted to the board. It can't be less than `definition.minRowSpan`.
+     * * `definition.defaultColumnSpan` (number, optional) - the number or columns the item will take when inserted in the board. It can't be less than `definition.minColumnSpan`.
+     * * `columnOffset` (mapping, optional) - the item's offset from the first column (per layout) starting from zero. The value is updated by `onItemsChange` after an update is committed.
+     * * `rowSpan` (number, optional) - the item's vertical size starting from two. The value is updated by `onItemsChange` after an update is committed.
+     * * `columnSpan` (number, optional) - the item's horizontal size starting from one. The value is updated by `onItemsChange` after an update is committed.
+     * * `data` (D) - optional item data which can include the specific configurations of an item, such as its title.
+     */
+    items: ReadonlyArray<BoardProps.Item<D>>;
+    /**
+     * Specifies a function to render content for board items. The return value must include board item component.
+     *
+     * The function takes the item and its associated actions (BoardProps.ItemActions) that include:
+     * * `removeItem(): void` - the callback to issue the item's removal. Once issued, the `onItemsChange` will fire to update the state.
+     */
+    renderItem: (item: BoardProps.Item<D>, actions: BoardProps.ItemActions) => JSX.Element;
+    /**
+     * An object containing all the necessary localized strings required by the component.
+     *
+     * Live announcements:
+     * * `liveAnnouncementDndStarted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate start of DnD ("reorder", "resize" or "insert").
+     * * `liveAnnouncementDndItemReordered(BoardProps.DndReorderState<D>): string` - the function to create a live announcement string to indicate when DnD reorder is performed.
+     * * `liveAnnouncementDndItemResized(BoardProps.DndResizeState<D>): string` - the function to create a live announcement string to indicate when DnD resize is performed.
+     * * `liveAnnouncementDndItemInserted(BoardProps.DndInsertState<D>): string` - the function to create a live announcement string to indicate when DnD insert is performed.
+     * * `liveAnnouncementDndDiscarded(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate commit of DnD ("reorder", "resize" or "insert").
+     * * `liveAnnouncementDndCommitted(BoardProps.DndOperationType): string` - the function to create a live announcement string to indicate discard of DnD ("reorder", "resize" or "insert").
+     * * `liveAnnouncementItemRemoved(BoardProps.OperationStateRemove<D>): string` - the function to create a live announcement string to indicate when item is removed.
+     *
+     * Navigation labels:
+     * * `navigationAriaLabel` (string) - the ARIA label for the accessible board navigation element.
+     * * `navigationAriaDescription` (string, optional) - the ARIA description for the accessible board navigation element.
+     * * `navigationItemAriaLabel(null | BoardProps.Item<D>): string` - the function to create the ARIA label for a navigation board item or an empty slot.
+     */
+    i18nStrings: BoardProps.I18nStrings<D>;
+    /**
+     * Fired when a user interaction changes size or position of board items.
+     *
+     * The change detail has the following properties:
+     * * `items`: (readonly Item<D>[]) - the updated items array.
+     * * `addedItem`: (Item<D>, optional) - the item that was added as part of the update, if available.
+     * * `removedItem`: (Item<D>, optional) - the item that was removed as part of the update, if available.
+     */
+    onItemsChange: NonCancelableEventHandler<BoardProps.ItemsChangeDetail<D>>;
+    /**
+     * Rendered when the `items` array is empty.
+     *
+     * When items are loading the slot can be used to render the loading indicator.
+     */
+    empty: ReactNode;
+}
+export declare namespace BoardProps {
+    type Item<D = DataFallbackType> = BoardItemDefinition<D>;
+    interface ItemActions {
+        removeItem(): void;
+    }
+    interface ItemsChangeDetail<D = DataFallbackType> {
+        items: ReadonlyArray<Item<D>>;
+        addedItem?: Item<D>;
+        removedItem?: Item<D>;
+    }
+    interface I18nStrings<D> {
+        liveAnnouncementDndStarted: (operationType: DndOperationType) => string;
+        liveAnnouncementDndItemReordered: (operation: DndReorderState<D>) => string;
+        liveAnnouncementDndItemResized: (operation: DndResizeState<D>) => string;
+        liveAnnouncementDndItemInserted: (operation: DndInsertState<D>) => string;
+        liveAnnouncementDndCommitted: (operationType: DndOperationType) => string;
+        liveAnnouncementDndDiscarded: (operationType: DndOperationType) => string;
+        liveAnnouncementItemRemoved: (operation: ItemRemovedState<D>) => string;
+        navigationAriaLabel: string;
+        navigationAriaDescription?: string;
+        navigationItemAriaLabel: (item: null | BoardProps.Item<D>) => string;
+    }
+    type DndOperationType = "reorder" | "resize" | "insert";
+    interface ItemPlacement {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    }
+    interface DndReorderState<D> {
+        item: Item<D>;
+        placement: ItemPlacement;
+        direction: "horizontal" | "vertical";
+        conflicts: readonly Item<D>[];
+        disturbed: readonly Item<D>[];
+    }
+    interface DndInsertState<D> {
+        item: Item<D>;
+        placement: ItemPlacement;
+        conflicts: readonly Item<D>[];
+        disturbed: readonly Item<D>[];
+    }
+    interface DndResizeState<D> {
+        item: Item<D>;
+        placement: ItemPlacement;
+        direction: "horizontal" | "vertical";
+        isMinimalColumnsReached: boolean;
+        isMinimalRowsReached: boolean;
+        conflicts: readonly Item<D>[];
+        disturbed: readonly Item<D>[];
+    }
+    interface ItemRemovedState<D> {
+        item: Item<D>;
+        disturbed: readonly Item<D>[];
+    }
+}
+export interface Transition<D> {
+    operation: Operation;
+    interactionType: InteractionType;
+    itemsLayout: GridLayout;
+    insertionDirection: null | Direction;
+    draggableItem: BoardItemDefinitionBase<D>;
+    draggableElement: HTMLElement;
+    acquiredItem: null | BoardItemDefinitionBase<D>;
+    collisionIds: Set<ItemId>;
+    layoutShift: null | LayoutShift;
+    path: readonly Position[];
+}
+export interface RemoveTransition<D> {
+    items: readonly BoardProps.Item<D>[];
+    removedItem: BoardItemDefinitionBase<D>;
+    layoutShift: LayoutShift;
+}
+export type TransitionAnnouncement = DndStartedAnnouncement | DndActionAnnouncement | DndCommittedAnnouncement | DndDiscardedAnnouncement | ItemRemovedAnnouncement;
+export interface DndStartedAnnouncement {
+    type: "dnd-started";
+    item: BoardItemDefinitionBase<unknown>;
+    operation: Operation;
+}
+export interface DndActionAnnouncement {
+    type: "dnd-action";
+    item: BoardItemDefinitionBase<unknown>;
+    operation: Operation;
+    placement: Omit<GridLayoutItem, "id">;
+    direction: null | Direction;
+    conflicts: Set<ItemId>;
+    disturbed: Set<ItemId>;
+}
+export interface DndCommittedAnnouncement {
+    type: "dnd-committed";
+    item: BoardItemDefinitionBase<unknown>;
+    operation: Operation;
+}
+export interface DndDiscardedAnnouncement {
+    type: "dnd-discarded";
+    item: BoardItemDefinitionBase<unknown>;
+    operation: Operation;
+}
+export interface ItemRemovedAnnouncement {
+    type: "item-removed";
+    item: BoardItemDefinitionBase<unknown>;
+    disturbed: Set<ItemId>;
+}

package/board/interfaces.js

@@ -0,0 +1 @@
+export {};

package/board/internal.d.ts

@@ -0,0 +1,4 @@
+/// <reference types="react" />
+import { InternalBaseComponentProps } from "../internal/base-component/use-base-component";
+import { BoardProps } from "./interfaces";
+export declare function InternalBoard<D>({ items, renderItem, onItemsChange, empty, i18nStrings, __internalRootRef, }: BoardProps<D> & InternalBaseComponentProps): JSX.Element;