commonMain.androidx.compose.foundation.gestures.Orientation.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of foundation-desktop Show documentation

Higher level abstractions of the Compose UI primitives. This library is design system agnostic, providing the high-level building blocks for both application and design-system developers

There is a newer version: 1.8.0-alpha01

Show newest version

/*
 * Copyright 2021 The Android Open Source Project
 *
 * Licensed 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.
 */

package androidx.compose.foundation.gestures

/**
 * Class to define possible directions in which common gesture modifiers like [draggable] and
 * [scrollable] can drag.
 */
enum class Orientation {
    /**
     * Vertical orientation representing Y axis
     */
    Vertical,

    /**
     * Horizontal orientation representing X axis.
     *
     * Note: this value specifies just the axis, not the direction (left-to-right or
     * right-to-left). To support RTL cases, use `reverseDirection = true` on [scrollable] and
     * [draggable].
     */
    Horizontal
}