|
| 1 | +{/* Copyright 2020 Adobe. All rights reserved. |
| 2 | +This file is licensed to you under the Apache License, Version 2.0 (the "License"); |
| 3 | +you may not use this file except in compliance with the License. You may obtain a copy |
| 4 | +of the License at http://www.apache.org/licenses/LICENSE-2.0 |
| 5 | +Unless required by applicable law or agreed to in writing, software distributed under |
| 6 | +the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS |
| 7 | +OF ANY KIND, either express or implied. See the License for the specific language |
| 8 | +governing permissions and limitations under the License. */} |
| 9 | + |
| 10 | +import {Layout} from '@react-spectrum/docs'; |
| 11 | +export default Layout; |
| 12 | + |
| 13 | +import docs from 'docs:@react-stately/dnd'; |
| 14 | +import {HeaderInfo, TypeContext, InterfaceType, FunctionAPI, TypeLink, PageDescription} from '@react-spectrum/docs'; |
| 15 | +import packageData from '@react-stately/dnd/package.json'; |
| 16 | + |
| 17 | +--- |
| 18 | +category: Drag and Drop |
| 19 | +keywords: [lists, state, dragging, dropping, drag, drop] |
| 20 | +--- |
| 21 | + |
| 22 | +# useDraggableCollectionState |
| 23 | + |
| 24 | +<PageDescription>{docs.exports.useDraggableCollectionState.description}</PageDescription> |
| 25 | + |
| 26 | +<HeaderInfo |
| 27 | + packageData={packageData} |
| 28 | + componentNames={['useDraggableCollectionState']} /> |
| 29 | + |
| 30 | +## API |
| 31 | + |
| 32 | +<FunctionAPI function={docs.exports.useDraggableCollectionState} links={docs.links} /> |
| 33 | + |
| 34 | +## Interface |
| 35 | + |
| 36 | +<TypeContext.Provider value={docs.links}> |
| 37 | + <InterfaceType properties={docs.links[docs.exports.useDraggableCollectionState.return.id].properties} /> |
| 38 | +</TypeContext.Provider> |
| 39 | + |
| 40 | +## Example |
| 41 | + |
| 42 | +See the docs for [useDraggableCollection](/react-aria/useDraggableCollection.html) in react-aria for an example of `useDraggableCollectionState`. |
0 commit comments