Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Chris Foulston committed Jun 14, 2018
1 parent 5b405b7 commit f97c93e
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

An attempt to mimic the ReorderableList within Unity while adding some extended functionality.

![](https://github.com/LeLocTai/Unity-Reorderable-List/blob/master/Screenshots/screenshot.jpg)
![](https://raw.githubusercontent.com/cfoulston/Unity-Reorderable-List/master/Screenshots/screenshot.jpg)

## Features

Expand All @@ -13,9 +13,32 @@ An attempt to mimic the ReorderableList within Unity while adding some extended
* Context menu items (revert values, duplicate values, delete values)
* Custom attribute which allows automatic list generation for properties*
* Event delegates and custom styling
* Pagination
* Sorting (sort based on field, ascending and descending)
___

## Usage

There are 2 ways to use the ReorderableList
There are two ways to use the ReorderableList
1. Create a custom Editor for your class and create a ReorderableList pointing to your serializedProperty
2. Create custom list class which extends from ReorderableArray<T>, assign [Reorderable] attribute above property (not class).
___

## Pagination

Pagination can be enabled in two ways:

1. With the [Reorderable] attribute:
* `[Reorderable(paginate = true, pageSize = 0)]`
2. Properties of the ReorderableList:
* `list.paginate`
* `list.pageSize`

`pageSize` defines the desired elements per page. Setting `pageSize = 0` will enable the custom page size GUI

When enabled, the ReorderableList GUI will display a small section below the header to facilitate navigating the pages

![](https://raw.githubusercontent.com/cfoulston/Unity-Reorderable-List/master/Screenshots/pagination.jpg)

#### NOTE
*Elements can be moved between pages by right-clicking and selecting "Move Array Element"*
Binary file added Screenshots/pagination.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit f97c93e

Please sign in to comment.