aboutsummaryrefslogtreecommitdiff
path: root/htmx/static/pico-1.5.11/docs/src/modal.html
blob: 5feb1cef671dabc524d4519b5ac517e1cb228ca1 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
<!doctype html>
<html lang="en">
  <head>
    ${require('./_head.html') 
      title=`Modal` 
      description=`A flexible container with graceful spacings across devices and viewports.`
      canonical=`modal.html`
    }
  </head>

  <body>
    ${require('./_nav.html')}
    
    <main class="container" id="docs">
      ${require('./_sidebar.html') active=`modal-link`}
      
      <div role="document">
        <section id="modal">
          <hgroup>
            <h1>Modal</h1>
            <h2>The classic modal element with graceful spacings across devices and viewports.</h2>
          </hgroup>

          <p>Modals are built with <code>&lt;<b>dialog</b>&gt;</code> as a wrapper and <code>&lt;<b>article</b>&gt;</code> as a content container.</p>
          <p>Inside <code>&lt;<b>header</b>&gt;</code>, <code>&lt;<b>a</b> <i>class</i>=<u>"close"</u>&gt;</code> is defined to <code><i>float</i>: <u>right</u>;</code> allowing a close icon to be top aligned with a title.</p>

          <dialog class="example" open>
            <article>
              <header>
                <a href="#close" aria-label="Close" class="close" onclick="event.preventDefault()"></a>
                <p>Modal title</p>
              </header>
              <p>
                Nunc nec ligula a tortor sollicitudin dictum in vel enim. 
                Quisque facilisis turpis vel eros dictum aliquam et nec turpis. 
                Sed eleifend a dui nec ullamcorper. 
                Praesent vehicula lacus ac justo accumsan ullamcorper.
              </p>
            </article>
          </dialog>

<pre><code>&lt;<b>dialog</b> <i>open</i>&gt;
  &lt;<b>article</b>&gt;
    &lt;<b>header</b>&gt;
      &lt;<b>a</b> <i>href</i>=<u>"#close"</u> <i>aria-label</i>=<u>"Close"</u> <i>class</i>=<u>"close"</u>&gt;&lt;/<b>a</b>&gt;
      Modal title
    &lt;/<b>header</b>&gt;
    &lt;<b>p</b>&gt;
      Nunc nec ligula a tortor sollicitudin dictum in vel enim. 
      Quisque facilisis turpis vel eros dictum aliquam et nec turpis. 
      Sed eleifend a dui nec ullamcorper. 
      Praesent vehicula lacus ac justo accumsan ullamcorper.
    &lt;/<b>p</b>&gt;
  &lt;/<b>article</b>&gt;
&lt;/<b>dialog</b>&gt;</code></pre>

          <p>Inside <code>&lt;<b>footer</b>&gt;</code>, the content is right aligned by default.</p>

          <dialog class="example" open>
            <article>
              <h3>Confirm your action!</h3>
              <p>
                Mauris non nibh vel nisi sollicitudin malesuada. 
                Donec ut sagittis erat. Praesent eu eros felis. 
                Ut consectetur placerat pulvinar.
              </p>
              <footer>
                <a href="#cancel" role="button" class="secondary" onclick="event.preventDefault()">Cancel</a><a href="#confirm" role="button" onclick="event.preventDefault()">Confirm</a>
              </footer>
            </article>
          </dialog>

<pre><code>&lt;<b>dialog</b> <i>open</i>&gt;
  &lt;<b>article</b>&gt;
    &lt;<b>h3</b>&gt;Confirm your action!&lt;/<b>h3</b>&gt;
    &lt;<b>p</b>&gt;
      Mauris non nibh vel nisi sollicitudin malesuada. 
      Donec ut sagittis erat. Praesent eu eros felis. 
      Ut consectetur placerat pulvinar.
    &lt;/<b>p</b>&gt;
    &lt;<b>footer</b>&gt;
      &lt;<b>a</b> <i>href</i>=<u>"#cancel"</u> <i>role</i>=<u>"button"</u> <i>class</i>=<u>"secondary"</u>&gt;Cancel&lt;/<b>a</b>&gt;
      &lt;<b>a</b> <i>href</i>=<u>"#confirm"</u> <i>role</i>=<u>"button"</u>&gt;Confirm&lt;/<b>a</b>&gt;
    &lt;/<b>footer</b>&gt;
  &lt;/<b>article</b>&gt;
&lt;/<b>dialog</b>&gt;</code></pre>

          <hgroup>
            <h2>Live demo</h2>
            <h3>Toggle a modal by clicking the button below.</h3>
          </hgroup>

          <article>
            <button class="contrast" data-target="modal-example" onclick="toggleModal(event)">Launch demo modal</button>
            <footer class="code">

<pre><code><em>&lt;!-- Button to trigger the modal --&gt;</em>
&lt;<b>button</b> <i>class</i>=<u>"contrast"</u>
  <i>data-target</i>=<u>"modal-example"</u>
  <i>onClick</i>=<u>"toggleModal(event)"</u>&gt;
  Launch demo modal
&lt;/<b>button</b>&gt;

<em>&lt;!-- Modal --&gt;</em>
&lt;<b>dialog</b> <i>id</i>=<u>"modal-example"</u>&gt;
  &lt;<b>article</b>&gt;
    &lt;<b>a</b> <i>href</i>=<u>"#close"</u>
      <i>aria-label</i>=<u>"Close"</u>
      <i>class</i>=<u>"close"</u>
      <i>data-target</i>=<u>"modal-example"</u>
      <i>onClick</i>=<u>"toggleModal(event)"</u>&gt;
    &lt;/<b>a</b>&gt;
    &lt;<b>h3</b>&gt;Confirm your action!&lt;/<b>h3</b>&gt;
    &lt;<b>p</b>&gt;
      Cras sit amet maximus risus. 
      Pellentesque sodales odio sit amet augue finibus pellentesque. 
      Nullam finibus risus non semper euismod.
    &lt;/<b>p</b>&gt;
    &lt;<b>footer</b>&gt;
      &lt;<b>a</b> <i>href</i>=<u>"#cancel"</u>
        <i>role</i>=<u>"button"</u>
        <i>class</i>=<u>"secondary"</u>
        <i>data-target</i>=<u>"modal-example"</u>
        <i>onClick</i>=<u>"toggleModal(event)"</u>&gt;
        Cancel
      &lt;/<b>a</b>&gt;
      &lt;<b>a</b> <i>href</i>=<u>"#confirm"</u>
        <i>role</i>=<u>"button"</u>
        <i>data-target</i>=<u>"modal-example"</u>
        <i>onClick</i>=<u>"toggleModal(event)"</u>&gt;
        Confirm
      &lt;/<b>a</b>&gt;
    &lt;/<b>footer</b>&gt;
  &lt;/<b>article</b>&gt;
&lt;/<b>dialog</b>&gt;</code></pre>

            </footer>
          </article>

          <p>Pico does not include JavaScript code. You will need to implement your JS to interact with modals.</p>
          <p>As a starting point, you can look at this example: <a href="https://github.com/picocss/examples/blob/master/v1-preview/js/modal.js">modal.js</a>.</p>
          <p>To make a modal appear, add the <code><i>open</i></code> attribute to the <code>&lt;<b>dialog</b></u>&gt;</code> container.</p>

<pre><code><em>&lt;!-- Open modal--&gt;</em>
&lt;<b>dialog</b> <i>open</i>&gt;
  &lt;<b>article</b>&gt;
  <em>…</em>
  &lt;/<b>article</b>&gt;
&lt;/<b>dialog</b>&gt;

<em>&lt;!-- Modal closed --&gt;</em>
&lt;<b>dialog</b>&gt;
  &lt;<b>article</b>&gt;
    <em>…</em>
  &lt;/<b>article</b>&gt;
&lt;/<b>dialog</b>&gt;
</code></pre>

          <h2>Utilities</h2>
          <p>Modals come with 3 utility classes.</p>
          <p>ℹ️&nbsp;These classes are not available in the <a href="classless.html">class-less version</a>.</p>
          <p><code>.modal-is-open</code> prevents any scrolling and interactions below the modal.</p>

<pre><code><em>&lt;!doctype html&gt;</em>
&lt;<b>html</b> <i>class</i>=<u>"modal-is-open"</u>&gt;
  <em>…</em>
&lt;/<b>html</b>&gt;</code></pre>

          <p><code>.modal-is-opening</code> brings an opening animation.</p>

<pre><code><em>&lt;!doctype html&gt;</em>
&lt;<b>html</b> <i>class</i>=<u>"modal-is-open modal-is-opening"</u>&gt;
  <em>…</em>
&lt;/<b>html</b>&gt;</code></pre>
        
          <p><code>.modal-is-closing</code> brings a closing animation.</p>

<pre><code><em>&lt;!doctype html&gt;</em>
&lt;<b>html</b> <i>class</i>=<u>"modal-is-open modal-is-closing"</u>&gt;
  <em>…</em>
&lt;/<b>html</b>&gt;</code></pre>

        </section>

        ${require('./_footer.html')}
        
      </div>
    </main>

    <dialog id="modal-example">
      <article>
        <a href="#close" aria-label="Close" class="close" data-target="modal-example" onclick="toggleModal(event)"></a>
        <h3>Confirm your action!</h3>
        <p>Cras sit amet maximus risus. Pellentesque sodales odio sit amet augue finibus pellentesque. Nullam finibus risus non semper euismod.</p>
        <footer>
          <a href="#cancel" role="button" class="secondary" data-target="modal-example" onclick="toggleModal(event)">Cancel</a><a href="#confirm" role="button" data-target="modal-example" onclick="toggleModal(event)">Confirm</a>
        </footer>
      </article>
    </dialog>

    <script src="js/commons.min.js"></script>
    <script src="js/modal.min.js"></script>
    
    </script>
  </body>
</html>