Skip to content

docs: improve grammar and brand consistency across docs #26

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

Merged
satnam72 merged 2 commits into from
Aug 25, 2025
Merged

docs: improve grammar and brand consistency across docs #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
d253a69
docs: improve grammer and brand consistency across docs
satnam72 Aug 25, 2025
cd7874b
docs: improve clarity and formatting
satnam72 Aug 25, 2025
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
6 changes: 3 additions & 3 deletions CONTRIBUTING.MD
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Contributing to allonsh.js
# Contributing to Allonsh.js

First off, thank you for considering contributing to allonsh.js! We welcome improvements, bug fixes, documentation updates, and ideas.
First off, thank you for considering contributing to Allonsh.js! We welcome improvements, bug fixes, documentation updates, and ideas.

## How to Contribute

Expand Down Expand Up @@ -83,4 +83,4 @@ Be respectful and courteous. We aim for an inclusive and welcoming community.

---

Thank you for contributing to allonsh.js!
Thank you for contributing to Allonsh.js!
7 changes: 5 additions & 2 deletions docs/allonsh.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Allonsh Docs
# Allonsh.js Docs

Create dynamic drag-and-drop interfaces with customizable behaviors like restricted dropzones, element stacking, and ghost visuals for seamless user interaction.

Expand All @@ -16,12 +16,15 @@ Creates a new Allonsh instance.
- `draggableSelector` (string, **required**) — CSS class name for draggable elements.
- `dropzoneSelector` (string, optional) — CSS class name for dropzone elements.
- `playAreaSelector` (string, optional) — CSS class name for the play area container. Defaults to `document.body`.
- `restrictToDropzones` (boolean, optional) — If `true`, dragging outside dropzones will return element to origin. Default: `false`.
- `restrictToDropzones` (boolean, optional) — If `true`, elements snap back to their origin if dropped outside any dropzone. Default: `false`.
- `enableStacking` (boolean, optional) — Enables stacking layout in dropzones. Default: `false`.
- `stackDirection` (string, optional) — `'horizontal'` or `'vertical'` stacking direction. Default: `'horizontal'`.
- `stackSpacing` (number, optional) — Space in pixels between stacked elements. Default: `5`.
- `useGhostEffect` (boolean, optional) — Uses a semi-transparent clone as a "ghost" while dragging. Default: `false`.

**Note:** The `draggableSelector`, `dropzoneSelector`, and `playAreaSelector` options expect class names, not CSS selectors (omit the leading '.').
For example, if the class is `.draggable`, pass `'draggable'` (without the dot).

---

## Methods
Expand Down