# binioter/guideview

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/binioter-guideview).**

3,946 stars · 654 forks · Java

## Links

- GitHub: https://github.com/binIoter/GuideView
- awesome-repositories: https://awesome-repositories.com/repository/binioter-guideview.md

## Description

GuideView is an Android user onboarding library and UI masking framework used to create guided tours and feature tutorials. It provides utilities for identifying and visually isolating specific Android views by drawing semi-transparent overlays with highlighted holes to focus user attention.

The library implements a system for chaining multiple instructional steps together, allowing for the sequencing of highlight pages in a specific order. It supports the attachment of custom text, images, or animations near highlighted views to provide instructional context.

The framework manages visual transitions between tutorial steps using animations and synchronizes the positioning of overlays with the Android fragment lifecycle. It uses coordinate-based masking and path clipping to define the visible areas of the interface.

## Tags

### User Interface & Experience

- [UI Masking](https://awesome-repositories.com/f/user-interface-experience/ui-masking.md) — Provides a framework for implementing semi-transparent overlays with cutouts to isolate views in Android apps.
- [View Masking Calculators](https://awesome-repositories.com/f/user-interface-experience/coordinate-based-position-calculators/view-masking-calculators.md) — Implements coordinate calculations to carve transparent holes in overlays that focus attention on specific Android views.
- [Focus Masking](https://awesome-repositories.com/f/user-interface-experience/element-masks/focus-masking.md) — Implements visual overlays that dim the interface to highlight a specific target element. ([source](https://github.com/binioter/guideview#readme))
- [Relational View Anchoring](https://awesome-repositories.com/f/user-interface-experience/floating-window-components/view-anchored-popups/view-controller-anchoring/relational-view-anchoring.md) — Relates instructional content to the boundary edges and centers of specific UI elements in the view hierarchy.
- [Guided Tour Libraries](https://awesome-repositories.com/f/user-interface-experience/guided-tour-libraries.md) — Implements a framework to manage the sequence, animation, and layout of instructional guide markers.
- [In-App User Education](https://awesome-repositories.com/f/user-interface-experience/in-app-user-education.md) — Offers contextual tutorials and assistance delivered directly within the application interface.
- [Sequenced Guidance Flows](https://awesome-repositories.com/f/user-interface-experience/interactive-ui-elements/interaction-controllers/pointer-event-restrictions/subtree-interaction-restrictions/guidance-interaction-restrictions/sequenced-guidance-flows.md) — Builds sequenced instructional flows that guide users through interface elements with synchronized animations.
- [User Onboarding Tours](https://awesome-repositories.com/f/user-interface-experience/user-onboarding-tours.md) — Creates interactive guided sequences to introduce new users to product features through highlighted steps.
- [Animation Interpolators](https://awesome-repositories.com/f/user-interface-experience/animation-interpolators.md) — Employs mathematical interpolation curves to smoothly animate mask position and size between tutorial steps.
- [Instructional Content Attachments](https://awesome-repositories.com/f/user-interface-experience/custom-tooltip-components/custom-onboarding-components/instructional-content-attachments.md) — Renders custom text, images, or animations near highlighted views to provide instructional context. ([source](https://github.com/binioter/guideview#readme))
- [Overlay Transition Animations](https://awesome-repositories.com/f/user-interface-experience/overlay-transition-animations.md) — Provides visual animations for the entry, exit, and transition of overlay masks between tutorial steps. ([source](https://github.com/binioter/guideview#readme))

### Part of an Awesome List

- [Sequential Navigation State](https://awesome-repositories.com/f/awesome-lists/devtools/react-native-navigation/navigation-state-management/sequential-navigation-state.md) — Manages the active step index and transition logic for a linear sequence of tutorial highlights.
- [Onboarding and Intro](https://awesome-repositories.com/f/awesome-lists/devtools/onboarding-and-intro.md) — Mask-style navigation and guide view.

### Graphics & Multimedia

- [Focus Masks](https://awesome-repositories.com/f/graphics-multimedia/graphics-engines-rendering/tile-map-renderers/raster-and-vector-tile-renderers/layer-based-composition/animation-layer-compositing/ui-masking-layers/focus-masks.md) — Provides visual overlays that obscure the interface while leaving specific elements visible to focus user attention.
- [Clipping Regions](https://awesome-repositories.com/f/graphics-multimedia/path-and-canvas-drawing/clipping-regions.md) — Uses path-based clipping regions to define the visible areas of highlight masks.

### Mobile Development

- [Android Onboarding Libraries](https://awesome-repositories.com/f/mobile-development/android-onboarding-libraries.md) — Serves as a dedicated Android library for creating masked overlays and sequenced tutorial steps.
- [View Highlighting Utilities](https://awesome-repositories.com/f/mobile-development/android-view-management/view-highlighting-utilities.md) — Provides utilities to identify and visually isolate Android views using customizable shapes and mask transitions.

### Software Engineering & Architecture

- [Fragment Lifecycle Integration](https://awesome-repositories.com/f/software-engineering-architecture/memory-usage-analysis/memory-leak-prevention/android-lifecycle-management/fragment-lifecycle-coordination/fragment-lifecycle-integration.md) — Binds the visibility and positioning of onboarding overlays to Android fragment lifecycle events.