Skip to content

Commit dc4f97a

Browse files
author
R. S. Doiel
committed
prep for v0.0.11, Renamed components to use a prefix of the standard element name they are extending.
1 parent 4975fed commit dc4f97a

File tree

121 files changed

+462
-346
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

121 files changed

+462
-346
lines changed

‎CITATION.cff‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,16 +8,16 @@ abstract: "CL-web-components provides a collection of Web Components used by Cal
88
The following are the components currently provided.
99
1010
11-
`a-to-z-ul`
11+
`ul-a-to-z`
1212
: This component takes an innerHTML containing a UL list. The UL list is then turned into an A to Z navigatable UL List. If JavaScript is unavailable then the innerHTML UL remains as a fallback.
1313
14-
`csv-textarea`
14+
`textarea-csv`
1515
: This is a textarea like component who's innerHTML content is CSV data. The component will display this as an editable table.
1616
17-
`input-agent-list`
17+
`textarea-agent-list`
1818
: This element wraps a textarea containing a list of agents expressed as JSON.
1919
20-
`sortable-table`
20+
`table-sortable`
2121
: This is a component that takes an innerHTML containing table. It makes the table sortable by the column headings and provides a filter input that lets you enter text to filter by and pick a column to filter on."
2222
authors:
2323
- family-names: Doiel
@@ -32,8 +32,8 @@ contacts:
3232
email: [email protected]
3333

3434
repository-code: "https://github.com/caltechlibrary/CL-web-components"
35-
version: 0.0.10
36-
date-released: 2025-07-03
35+
version: 0.0.11
36+
date-released: 2025-07-07
3737

3838
license-url: "https://caltechlibrary.github.io/CL-web-components/LICENSE"
3939
keywords:

‎DEVELOPERS.html‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
<!DOCTYPE html>
2+
<html lang="en-US">
3+
<head>
4+
<title>CL-web-components</title>
5+
<link rel="stylesheet" href="/css/site.css">
6+
</head>
7+
<body>
8+
<nav>
9+
<ul>
10+
<li><a href="/">Home</a></li>
11+
<li><a href="index.html">README</a></li>
12+
<li><a href="LICENSE">LICENSE</a></li>
13+
<li><a href="user_manual.html">User Manual</a></li>
14+
<li><a href="INSTALL.html">INSTALL</a></li>
15+
<li><a href="about.html">About</a></li>
16+
<li><a href="search.html">Search</a></li>
17+
<li><a href="https://github.com/caltechlibrary/CL-web-components">GitHub</a></li>
18+
</ul>
19+
</nav>
20+
<section>
21+
<h1 id="developer-notes">Developer Notes</h1>
22+
<p>This is a new endevour for Caltech Library. Our practices are
23+
evolving as we devlop this project and we periodically make course
24+
corrections. In I hope to highlight approaches or technique that proved
25+
useful.</p>
26+
<h2 id="heuristics">Heuristics</h2>
27+
<ul>
28+
<li>this project is focused on web components useful to Libraries,
29+
Archives and Museums</li>
30+
<li>when a component extends a standard HTML element the standard
31+
element name should be used as a prefix,
32+
e.g. <code>&lt;textarea-agent-list&gt;</code>,
33+
<code>&lt;ul-a-to-z-list&gt;</code></li>
34+
</ul>
35+
</section>
36+
</body>
37+
</html>

‎DEVELOPERS.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
2+
# Developer Notes
3+
4+
This is a new endevour for Caltech Library. Our practices are evolving as we devlop this project and we periodically make course corrections. In I hope to highlight approaches or technique that proved useful.
5+
6+
## Heuristics
7+
8+
- this project is focused on web components useful to Libraries, Archives and Museums
9+
- when a component extends a standard HTML element the standard element name should be used as a prefix, e.g. `<textarea-agent-list>`, `<ul-a-to-z-list>`

‎INSTALL.html‎

Lines changed: 24 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -19,26 +19,31 @@
1919
</nav>
2020
<section>
2121
<h1 id="cl-web-components">CL-web-components</h1>
22-
<p>Current the CL-web-components can be downloaded from the GitHub, <a
23-
href="https://github.com/caltechlibrary/CL-web-components"
24-
class="uri">https://github.com/caltechlibrary/CL-web-components</a>, or
25-
import as <a href="">ES6 Modules</a> from <a
22+
<p>The CL-web-components repository provide web components for Library,
23+
Archive and Museum related projects implemented at Caltech Library. They
24+
are available for import from <a
2625
href="https://caltechlibrary.github.io/CL-web-components"
27-
class="uri">https://caltechlibrary.github.io/CL-web-components</a>
28-
followed by the module’s JavaScript filename.</p>
29-
<p>The <code>csv-textarea</code> web component is importable using
30-
<code>import { CSVTextarea } from 'https://caltechlibrary.github.io/CL-web-components/csvtextarea.js';</code>.
31-
You can import it into your HTML document using an ES6 script element in
32-
your web page,
33-
<code>&lt;script type="module" src="https://caltechlibrary.github.io/CL-web-components/csvtextarea.js"&gt;&lt;/script&gt;</code>.</p>
34-
<p>The <code>a-to-z-ul</code> web component is importable using
35-
<code>import { AtoZUL } from 'https://caltechlibrary.github.io/CL-web-components/a_to_z_ul.js';</code>.
36-
You can import it into your HTML document using an ES6 script element in
37-
your web page,
38-
<code>&lt;script type="module" src="https://caltechlibrary.github.io/CL-web-components/a_to_z_url.js"&gt;&lt;/script&gt;</code>.</p>
39-
<p>A third module is available called <code>parseCSV.js</code>. This is
40-
used by <code>CSVTextarea</code>. It provides stringify and parse
41-
methods for CSV content.</p>
26+
class="uri">https://caltechlibrary.github.io/CL-web-components</a> using
27+
the following import statement, `import * as clwc from
28+
“https://caltechlibrary.github.io/CL-web-compents/mod.js”.</p>
29+
<p>It recommended that you download the Zip file containing the
30+
individual components as well as the bundled components from <a
31+
href="https://github.com/caltechlibrary/CL-web-components/releases"
32+
class="uri">https://github.com/caltechlibrary/CL-web-components/releases</a>.
33+
Each component is bundled individually as well as all together in the
34+
file <code>cl-web-components.js</code>.</p>
35+
<p>The zip files are provided for each release. They include the release
36+
number in the filename. The combined bundle includes the version,
37+
releaseDate, releaseHash and licenseText in the bundle.</p>
38+
<p>Here’s an example of getting the v0.0.11
39+
<code>cl-web-compponents.js</code> combined bundled from the release on
40+
macOS or Linux.</p>
41+
<pre><code>curl -L -O https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip
42+
unzip cl-web-components-0.0.11.zip cl-web-components.js</code></pre>
43+
<p>And on Windows using PowerShell.</p>
44+
<pre><code>irm -OutFile recipes.jsonl `
45+
https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip
46+
Expand-Archive -Path &quot;cl-web-components-0.0.11.zip&quot; -Item &quot;cl-web-components.js&quot;</code></pre>
4247
</section>
4348
</body>
4449
</html>

‎INSTALL.md‎

Lines changed: 18 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,24 @@
11

22
# CL-web-components
33

4-
Current the CL-web-components can be downloaded from the GitHub, <https://github.com/caltechlibrary/CL-web-components>, or import as [ES6 Modules]() from <https://caltechlibrary.github.io/CL-web-components> followed by the module's JavaScript filename.
4+
The CL-web-components repository provide web components for Library, Archive and Museum related projects implemented at Caltech Library. They are available for import from <https://caltechlibrary.github.io/CL-web-components> using the following import statement, `import * as clwc from "https://caltechlibrary.github.io/CL-web-compents/mod.js".
55

6-
The `csv-textarea` web component is importable using `import { CSVTextarea } from 'https://caltechlibrary.github.io/CL-web-components/csvtextarea.js';`. You can import it into your HTML document using an ES6 script element in your web page, `<script type="module" src="https://caltechlibrary.github.io/CL-web-components/csvtextarea.js"></script>`.
6+
It recommended that you download the Zip file containing the individual components as well as the bundled components from <https://github.com/caltechlibrary/CL-web-components/releases>. Each component is bundled individually as well as all together in the file `cl-web-components.js`.
77

8-
The `a-to-z-ul` web component is importable using `import { AtoZUL } from 'https://caltechlibrary.github.io/CL-web-components/a_to_z_ul.js';`. You can import it into your HTML document using an ES6 script element in your web page, `<script type="module" src="https://caltechlibrary.github.io/CL-web-components/a_to_z_url.js"></script>`.
8+
The zip files are provided for each release. They include the release number in the filename. The combined bundle includes the version, releaseDate, releaseHash and licenseText in the bundle.
9+
10+
Here's an example of getting the v0.0.11 `cl-web-compponents.js` combined bundled from the release on macOS or Linux.
11+
12+
~~~
13+
curl -L -O https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip
14+
unzip cl-web-components-0.0.11.zip cl-web-components.js
15+
~~~
16+
17+
And on Windows using PowerShell.
18+
19+
~~~
20+
irm -OutFile recipes.jsonl `
21+
https://github.com/caltechlibrary/CL-web-components/releases/download/v0.0.10/cl-web-components-0.0.11.zip
22+
Expand-Archive -Path "cl-web-components-0.0.11.zip" -Item "cl-web-components.js"
23+
~~~
924

10-
A third module is available called `parseCSV.js`. This is used by `CSVTextarea`. It provides stringify and parse methods for CSV content.
11-

‎Makefile‎

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@ PROJECT = CL-web-components
55

66
GIT_GROUP = caltechlibrary
77

8+
WEB_COMPONENTS = ul-a-to-z-list.js textarea-agent-list.js textarea-csv.js table-sortable.js
9+
810
RELEASE_DATE = $(shell date +%Y-%m-%d)
911

1012
RELEASE_HASH=$(shell git log --pretty=format:'%h' -n 1)
@@ -33,11 +35,14 @@ ifeq ($(OS), Windows)
3335
EXT = .exe
3436
endif
3537

36-
build: $(PROGRAMS) CITATION.cff about.md
38+
build: $(PROGRAMS) CITATION.cff about.md version.js
3739

3840
hash: .FORCE
3941
git log --pretty=format:'%h' -n 1
4042

43+
version.js: .FORCE
44+
cmt codemeta.json version.js
45+
4146
CITATION.cff: codemeta.json
4247
cmt codemeta.json CITATION.cff
4348

@@ -68,15 +73,16 @@ clean:
6873

6974
dist: .FORCE
7075
@mkdir -p dist
71-
@rm -fR dist/* >/dev/null
72-
cp *.js dist/
76+
@rm -fR dist/* >/dev/null
77+
deno bundle --platform=browser --outdir=dist $(WEB_COMPONENTS)
78+
deno bundle --platform=browser --output=dist/cl-web-components.js mod.js
7379
cp INSTALL.md dist/
7480
cp LICENSE dist/
7581
cp about.md dist/
7682
cp README.md dist/
7783
cp codemeta.json dist/
7884
cp CITATION.cff dist/
79-
cd dist && zip cl-web-components-$(VERSION).zip *.md LICENSE CITATION.cff codemeta.json *.js
85+
cd dist && zip cl-web-components-$(VERSION).zip *.md LICENSE CITATION.cff codemeta.json $(WEB_COMPONENTS) cl-web-components.js
8086

8187
release: dist
8288
@printf "\nReady to do ./release.bash\n\n"

‎README.md‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,40 +1,51 @@
11

2-
# CL-web-components
2+
3+
# CL-web-components 0.0.11
34

45
CL-web-components provides a collection of Web Components used by Caltech Library in various web sites and projects.
56

67
The following are the components currently provided.
78

89

9-
`a-to-z-ul`
10+
`ul-a-to-z`
1011
: This component takes an innerHTML containing a UL list. The UL list is then turned into an A to Z navigatable UL List. If JavaScript is unavailable then the innerHTML UL remains as a fallback.
1112

12-
`csv-textarea`
13+
`textarea-csv`
1314
: This is a textarea like component who's innerHTML content is CSV data. The component will display this as an editable table.
1415

15-
`input-agent-list`
16+
`textarea-agent-list`
1617
: This element wraps a textarea containing a list of agents expressed as JSON.
1718

18-
`sortable-table`
19+
`table-sortable`
1920
: This is a component that takes an innerHTML containing table. It makes the table sortable by the column headings and provides a filter input that lets you enter text to filter by and pick a column to filter on.
2021

2122
## Release Notes
2223

23-
- version: 0.0.9
24+
- version: 0.0.11
2425
- status: wip
25-
- released: 2025-07-03
26+
- released: 2025-07-07
27+
28+
Renamed components to use a prefix of the standard element name they are extending.
2629

27-
Added a new &#x60;&lt;input-agent-list&gt;&lt;/input-agent-list&gt;&#x60; web component. This allows you to use a textarea containing a list of agents (people and organizations)
28-
to be presented as a friendly editing element while preserving the textarea with JSON as a fallback.
2930

3031
### Authors
3132

3233
- Doiel, R. S.
3334

35+
36+
3437
### Maintainers
3538

3639
- Doiel, R. S.
3740

41+
42+
## Software Suggestions
43+
44+
- CMTools &gt;&#x3D; 0.0.33
45+
- Pandoc &gt;&#x3D; 3.1
46+
47+
**Uses: HTML5-compatible web browser**
48+
3849
## Related resources
3950

4051

‎about.html‎

Lines changed: 13 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19,9 +19,9 @@
1919
</nav>
2020
<section>
2121
<h1 id="about-this-software">About this software</h1>
22-
<h2 id="cl-web-components-0.0.10">CL-web-components 0.0.10</h2>
23-
<p>Added support for "people-only" and "organization-only" attributes in
24-
`&lt;input-agent-list&gt;&lt;/input-agent-list&gt;`.</p>
22+
<h2 id="cl-web-components-0.0.11">CL-web-components 0.0.11</h2>
23+
<p>Renamed components to use a prefix of the standard element name they
24+
are extending.</p>
2525
<h3 id="authors">Authors</h3>
2626
<ul>
2727
<li>R. S. Doiel, <a href="https://orcid.org/0000-0003-0900-6903"
@@ -36,23 +36,23 @@ <h3 id="maintainers">Maintainers</h3>
3636
Caltech Library in various web sites and projects.</p>
3737
<p>The following are the components currently provided.</p>
3838
<dl>
39-
<dt>`a-to-z-ul`</dt>
39+
<dt>`ul-a-to-z`</dt>
4040
<dd>
4141
This component takes an innerHTML containing a UL list. The UL list is
4242
then turned into an A to Z navigatable UL List. If JavaScript is
4343
unavailable then the innerHTML UL remains as a fallback.
4444
</dd>
45-
<dt>`csv-textarea`</dt>
45+
<dt>`textarea-csv`</dt>
4646
<dd>
4747
This is a textarea like component who's innerHTML content is CSV data.
4848
The component will display this as an editable table.
4949
</dd>
50-
<dt>`input-agent-list`</dt>
50+
<dt>`textarea-agent-list`</dt>
5151
<dd>
5252
This element wraps a textarea containing a list of agents expressed as
5353
JSON.
5454
</dd>
55-
<dt>`sortable-table`</dt>
55+
<dt>`table-sortable`</dt>
5656
<dd>
5757
This is a component that takes an innerHTML containing table. It makes
5858
the table sortable by the column headings and provides a filter input
@@ -76,6 +76,12 @@ <h3 id="programming-languages">Programming languages</h3>
7676
<li>HTML</li>
7777
<li>CSS</li>
7878
</ul>
79+
<h3 id="software-suggestions">Software Suggestions</h3>
80+
<ul>
81+
<li>Deno &gt;= 2.4</li>
82+
<li>CMTools &gt;= 0.0.33</li>
83+
<li>Pandoc &gt;= 3.1</li>
84+
</ul>
7985
</section>
8086
</body>
8187
</html>

0 commit comments

Comments
 (0)