io.github.wimdeblauwe.htmx.spring.boot.mvc.HxReswap Maven / Gradle / Ivy

Go to download
package io.github.wimdeblauwe.htmx.spring.boot.mvc;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * Annotation to specify how the response will be swapped.
 * See hx-swap for possible values.
 *
 * @see HX-Reswap
 */
@Target({ElementType.TYPE, ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface HxReswap {

    /**
     * A value to specify how the response will be swapped.
     *
     * @see hx-swap
     */
    HxSwapType value() default HxSwapType.INNER_HTML;

    /**
     * Set the time in milliseconds that should elapse after receiving a response to swap the content.
     */
    long swap() default -1;

    /**
     * Set the time in milliseconds that should elapse between the swap and the settle logic.
     */
    long settle() default -1;

    /**
     * Changes the scrolling behavior of the target element.
     */
    Position scroll() default Position.UNDEFINED;

    /**
     * Used to target a different element for scrolling.
     */
    String scrollTarget() default "";

    /**
     * Changes the scrolling behavior of the target element.
     */
    Position show() default Position.UNDEFINED;

    /**
     * Used to target a different element for showing.
     */
    String showTarget() default "";

    /**
     * Enables the use of the new
     * View Transitions API
     * when a swap occurs.
     */
    boolean transition() default false;

    /**
     * Enable or disable auto-scrolling to focused inputs between requests.
     */
    FocusScroll focusScroll() default FocusScroll.UNDEFINED;

    /**
     * Represents the values for {@link #focusScroll()}
     */
    public enum FocusScroll {
        TRUE,
        FALSE,
        UNDEFINED
    }

    /**
     * Represents the position values for {@link #show()} and {@link #scroll()}
     */
    public enum Position {
        TOP,
        BOTTOM,
        UNDEFINED
    }

}