https://github.com/ToshikiImagawa/Scrmizu

Variable infinite scroll in Unity UI
https://github.com/ToshikiImagawa/Scrmizu

Last synced: about 2 months ago
JSON representation

Variable infinite scroll in Unity UI

• Host: GitHub
• URL: https://github.com/ToshikiImagawa/Scrmizu
• Owner: ToshikiImagawa
• License: mit
• Created: 2017-08-26T07:11:24.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T09:28:16.000Z (10 months ago)
• Last Synced: 2024-05-22T10:16:41.227Z (8 months ago)
• Language: C#
• Size: 451 KB
• Stars: 72
• Watchers: 4
• Forks: 6
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-unity-open-source-on-github - Variable-infinite-scroll - Variable infinite scroll (Scroll)

README

        
[![license](https://img.shields.io/github/license/ToshikiImagawa/Variable-infinite-scroll?style=flat-square)](https://github.com/ToshikiImagawa/Variable-infinite-scroll/blob/master/LICENSE.md)

[![release](https://img.shields.io/github/release/ToshikiImagawa/Variable-infinite-scroll?style=flat-square)](https://github.com/ToshikiImagawa/Variable-infinite-scroll/releases)

# What is Scrmizu

Scrmizu is variable infinite scroll and extended UnityEngine.UI.ScrollRect for Unity UGUI.

# Required

- Unity 2020.3.45f1 or later.

- Scripting Runtime Version 4.6 Eq.

# Install

1. Download Scrmizu.unitypackage [here](https://github.com/ToshikiImagawa/Variable-infinite-scroll/releases).

1. Import the contents of the Scrmizu folder to the Packages or Assets folder.

1. Optionally import Scrmizu.Sample.unitypackage.

# Quick start

## Infinite Scroll View

To create a Infinite Scroll View in the Unity Editor, go to GameObject → UI → Infinite Scroll View.



Prepare ScrollItem prefab to be repeatedly displayed by infinite scroll.



```c#:SimpleInfiniteScrollItem.cs

public class SimpleInfiniteScrollItem : MonoBehaviour, IInfiniteScrollItem

{

    /// 

    /// ScrollItem enters display area and updates display item data.

    /// 

    /// 

    public void UpdateItemData(object data)

    {

        if (!(data is float width)) return;

        gameObject.SetActive(true);

        if (!(gameObject.transform is RectTransform rectTransform)) return;

        rectTransform.sizeDelta = new Vector2(width, rectTransform.sizeDelta.y);

    }

    /// 

    /// Hide ScrollItem because it has left the display area.

    /// 

    public void Hide()

    {

        gameObject.SetActive(false);

    }

}

```

Call InfiniteScrollRect.SetItemData to set the item data.

```c#:SimpleInfiniteScrollController.cs

[RequireComponent(typeof(InfiniteScrollRect))]

public class SimpleInfiniteScrollController : MonoBehaviour

{

    private InfiniteScrollRect _infiniteScrollRect;

    private InfiniteScrollRect InfiniteScrollRect => _infiniteScrollRect != null

        ? _infiniteScrollRect : _infiniteScrollRect = GetComponent();

    private void Awake()

    {

        InfiniteScrollRect.SetItemData(new object[]

        {

            200f, 

            300f, 

            400f, 

            500f, 

            600f, 

            700f, 

            800f, 

            900f, 

            1000f

        });

    }

}

```

By scrolling, you can confirm that the width of the scroll item is updated for each set data (width).

## Nested Scroll View

To create a Nested Scroll View in the Unity Editor, go to GameObject → UI → Nested Scroll View.

Put it under the Scroll View container.



When scrolling in the non-scroll direction of NestedScrollView, scroll event is sent to the parent ScrollView.

## Paged Scroll View

To create a Paged Scroll View in the Unity Editor, go to GameObject → UI → Paged Scroll View.

Create multiple page content items under content.



One item is displayed in the scroll direction in the view area.

Pauses the page each time scroll.