Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
V
vue-draggable-grid
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Package Registry
Model registry
Operate
Terraform modules
Monitor
Service Desk
Analyze
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
AlekSIS®
Libraries
vue-draggable-grid
Commits
311e3142
Commit
311e3142
authored
2 years ago
by
Julian
Browse files
Options
Downloads
Patches
Plain Diff
Document all props for singular grids
parent
fbe19f8a
No related branches found
No related tags found
1 merge request
!2
Resolve "Implement basic functionality"
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/guide/index.md
+65
-0
65 additions, 0 deletions
docs/guide/index.md
with
65 additions
and
0 deletions
docs/guide/index.md
+
65
−
0
View file @
311e3142
...
@@ -78,3 +78,68 @@ The highlighted items are not draggable.
...
@@ -78,3 +78,68 @@ The highlighted items are not draggable.
If the boolean property
`disabled`
is set for the whole grid, the grid itself is disabled,
If the boolean property
`disabled`
is set for the whole grid, the grid itself is disabled,
and items can't be moved.
and items can't be moved.
## Programmatic validation of movements
It is also possible to supply a function to dynamically or programmatically hinder fields from being moved to,
and items from being moved. This can be done by supplying a function which takes the
`x`
and
`y`
coordinates of
the field as well as the key of the item. If
`false`
is returned, the movement is prohibited. The highlight which
appears when dragging an element is also disabled for this field.
Examples for such methods are the following:
```
javascript
function
blockField
(
x
,
y
,
key
)
{
// We won't move items with ID 'obj8' and nothing into (3, 3) and (4, 3)
if
(
x
===
3
&&
y
===
3
)
return
false
;
if
(
x
===
4
&&
y
===
3
)
return
false
;
return
key
!==
"
obj8
"
;
};
function
blockAllMoving
()
{
return
false
;
};
```
## Changing the highlight
The highlight is the grey-bordered rectangle which appears when dragging over a field.
### Custom highlight
To customize the highlight, use the
`highlight`
slot inside the grid component.
```
html
<drag-grid
v-model=
"items"
:cols=
"3"
:rows=
"2"
>
<template
#highlight
>
<div
ref=
"highlight"
class=
"custom-highlight"
>
This is a custom highlight with a custom style!
</div>
</template>
</drag-grid>
```
### Disabled highlight
To disable the highlight, use the
`no-highlight`
prop.
## Changing items on move
It is possible to make changes to an item once it moved successfully. One can supply a function in the
`validate-element`
prop which gets called on a moved item and can make (in place) changes to it. Such a
function could look like this:
```
javascript
function
randomKey
(
element
)
{
if
(
element
.
key
.
length
!==
1
)
return
;
element
.
key
+=
Math
.
random
().
toString
(
36
).
replace
(
"
0.
"
,
""
);
};
```
This method changes the key of a moved item to a random string if the key has a length of 1.
This is used inside example 2 (the tic-tac-toe game).
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment