Skip to content
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.

Sign up for GitHub

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

made change in dnd kit documentation for the autoScroll prop #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

made change in dnd kit documentation for the autoScroll prop #20

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 16 additions & 2 deletions api-documentation/context-provider/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If multiple `DndContext` providers are listening for the same event, events will
```typescript
interface Props {
announcements?: Announcements;
autoScroll?: boolean;
autoScroll?: boolean | AutoScrollOptions;
cancelDrop?: CancelDrop;
children?: React.ReactNode;
collisionDetection?: CollisionDetection;
Expand All @@ -71,6 +71,20 @@ interface Props {
onDragEnd?(event: DragEndEvent): void;
onDragCancel?(): void;
}

interface AutoScrollOptions {
acceleration?: number;
activator?: AutoScrollActivator;
canScroll?: CanScroll;
enabled?: boolean;
interval?: number;
layoutShiftCompensation?: boolean | {x: boolean, y: boolean};
order?: TraversalOrder;
threshold?: {
x: number;
y: number;
};
}
```

### Event handlers
Expand Down Expand Up @@ -156,7 +170,7 @@ Use the `screenReaderInstructions` prop to customize the instructions that are r

### Autoscroll

Use the optional `autoScroll` boolean prop to temporarily or permanently disable auto-scrolling for all sensors used within this `DndContext`.
Use the optional `autoScroll` prop to temporarily or permanently disable auto-scrolling for all sensors used within this `DndContext`.

Auto-scrolling may also be disabled on an individual sensor basis using the static property `autoScrollEnabled` of the sensor. For example, the [Keyboard sensor](../sensors/keyboard.md) manages scrolling internally, and therefore has the static property `autoScrollEnabled` set to `false`.

Expand Down