%% ***********************************************************
%%   Copyright 2024 by Mingyu Hsia <xiamyphys@gmail.com>     *
%%                                                           *
%%   This work may be distributed and/or modified under      *
%%   the conditions of the LaTeX Project Public License      *
%%                                                           *
%%       http://www.latex-project.org/lppl.txt               *
%%                                                           *
%%   either version 1.3c of this license or any later        *
%%   version.                                                *
%%                                                           *
%%   This work has the LPPL maintenance status `maintained'. *
%%                                                           *
%%   The Current Maintainer of this work is Mingyu Hsia.     *
%%                                                           *
%%   This work consists of the files fadingimage.cls,        *
%%                               and README.md.              *
%%   available at https://github.com/xiamyphys/fadingimage   *
%% ***********************************************************
% !Mode:: "TeX:UTF-8"
\NeedsTeXFormat{LaTeX2e}[2020/10/01]
\ProvidesPackage{fadingimage}[2024/04/19/ v0.2a Package for adding fading full width picture at the top and bottom of a page.]

\RequirePackage{tikz,xcolor}
\usetikzlibrary{fadings}
\NewDocumentCommand{\UPFadingImage}{ s O{} m }{
    \IfBooleanTF{#1}
    {
        \tikz[remember picture,overlay]
            \node[below,inner sep=0pt,outer sep=auto] at (current page.north) {\includegraphics[width=\paperwidth,#2]{#3}};
    }{
        \tikz[remember picture,overlay]
            \node[scope fading=south,below,inner sep=0pt,outer sep=auto] at (current page.north) {\includegraphics[width=\paperwidth,#2]{#3}};
    }
}
\NewDocumentCommand{\LOWFadingImage}{ s O{} m }{
    \IfBooleanTF{#1}
    {
        \tikz[remember picture,overlay]
            \node[above,inner sep=0pt,outer sep=auto] at (current page.south) {\includegraphics[width=\paperwidth,#2]{#3}};
    }{
        \tikz[remember picture,overlay]
            \node[scope fading=north,above,inner sep=0pt,outer sep=auto] at (current page.south) {\includegraphics[width=\paperwidth,#2]{#3}};
    }
}

\NewDocumentCommand{\UPLOWFadingImage}{ s O{} m O{} m }{
    \IfBooleanTF{#1}
    {
        \tikz[remember picture,overlay]{
            \node[below,inner sep=0pt,outer sep=auto] at (current page.north) {\includegraphics[width=\paperwidth,#2]{#3}};
            \node[above,inner sep=0pt,outer sep=auto] at (current page.south) {\includegraphics[width=\paperwidth,#4]{#5}};
        }
    }{
        \tikz[remember picture,overlay]{
            \node[scope fading=south,below,inner sep=0pt,outer sep=auto] at (current page.north) {\includegraphics[width=\paperwidth,#2]{#3}};
            \node[scope fading=north,above,inner sep=0pt,outer sep=auto] at (current page.south) {\includegraphics[width=\paperwidth,#4]{#5}};
        }
    }
}