Centering Recycler View

Additional

Language
Java
Version
N/A
Created
Nov 27, 2015
Updated
Mar 3, 2023
Owner
Shigehiro Soejima (mightyfrog)
Contributor
Shigehiro Soejima (mightyfrog)
1
Activity
Badge
Generate
Download
Source code

Centering Recycler View (Android)

A RecyclerView implementation that scrolls a view to center (top, bottom, left, or right).

Download  

implementation 'org.mightyfrog.centeringrecyclerview:centeringrecyclerview:1.1.8'

Use v1.0.11 if you need Android Support Library v23.2.1 or older AND StaggeredGridLayoutMangaer

implementation 'org.mightyfrog.centeringrecyclerview:centeringrecyclerview:1.0.11'

Usage

center, head, tail(int position) - scrolls a view at the specified position to center, head, or tail

CenteringRecyclerView mRecyclerView;
...
int position = 100; // adapter position
mRecyclerView.center(position);

mRecyclerView.head(position); // vertical: scrolls to top, horizontal: scrolls to left 

mRecyclerView.tail(position); // vertical: scrolls to bottom, horiztal: scrolls to right

snap(int, int) - snaps a view at the specified position to the closer end

CenteringRecyclerView mRecyclerView;
...
mRecyclerView.snap(10, CenteringRecyclerView.SNAPPING_STRATEGY_CENTER);

alternative method: setSelection(int position, int alignment)

CenteringRecyclerView mRecyclerView;
...
int position = 100; // adapter position
mRecyclerView.setSelection(position, CenteringRecyclerView.ALIGN_CENTER);

If you don't want already (completely) visible views re-laid out, set ignoreIfVisible or ignoreIfCompletelyVisible to true.

mRecyclerView.setIgnoreIfVisible(true);

mRecyclerView.setIgnoreIfCompletelyVisible(true);

XML attributes

<org.mightyfrog.widget.CenteringRecyclerView
  ...
  app:ignoreIfVisible="true" />

<org.mightyfrog.widget.CenteringRecyclerView
  ...
  app:ignoreIfCompletelyVisible="true" />

other public methods

isVisible(int position);

isCompletelyVisible(int position)

getFirstVisiblePosition()

getLastVisiblePosition()

getFirstCompletelyVisiblePosition()

getLastCompletelyVisiblePosition()

License

Copyright 2015 Shigehiro Soejima.

Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.