@curtissimo/elm-split-pane 1.0.0-alpha.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE +23 -0
- package/README.md +66 -0
- package/package.json +39 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,23 @@
|
|
|
1
|
+
|
|
2
|
+
MIT License
|
|
3
|
+
|
|
4
|
+
Copyright (c) 2026 Curtis Schlak.
|
|
5
|
+
|
|
6
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy of
|
|
7
|
+
this software and associated documentation files (the " Software"), to deal in
|
|
8
|
+
the Software without restriction, including without limitation the rights to
|
|
9
|
+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
|
|
10
|
+
the Software, and to permit persons to whom the Software is furnished to do so,
|
|
11
|
+
subject to the following conditions:
|
|
12
|
+
|
|
13
|
+
The above copyright notice and this permission notice (including the next
|
|
14
|
+
paragraph) shall be included in all copies or substantial portions of the
|
|
15
|
+
Software.
|
|
16
|
+
|
|
17
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
18
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
|
|
19
|
+
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
|
|
20
|
+
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
|
|
21
|
+
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
|
|
22
|
+
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
|
23
|
+
|
package/README.md
ADDED
|
@@ -0,0 +1,66 @@
|
|
|
1
|
+
# Curtissimo.ElmSplit-pane
|
|
2
|
+
|
|
3
|
+
[](https://gitlab.com/curtissimo/elm-split-pane/-/pipelines/latest)
|
|
4
|
+
|
|
5
|
+
A nestable split pane for Elm.
|
|
6
|
+
|
|
7
|
+
<!-- Replace the link if you choose to use the GitLab Unique Domain feature. -->
|
|
8
|
+
Check out the [live example](https://curtissimo.gitlab.io/elm-split-pane).
|
|
9
|
+
Source for the examples can be found in the [`./examples`](./examples)
|
|
10
|
+
directory.
|
|
11
|
+
|
|
12
|
+
## Design Goals
|
|
13
|
+
|
|
14
|
+
> Adapted from Dillon Kearns' [design goals
|
|
15
|
+
> advice](https://github.com/dillonkearns/idiomatic-elm-package-guide#explicitly-state-design-goals-in-your-readme):
|
|
16
|
+
>
|
|
17
|
+
> **What differentiates your project from any other project out there?**
|
|
18
|
+
>
|
|
19
|
+
> Since Elm
|
|
20
|
+
> packages are reliable due to the nature of the elm language and its guarantees,
|
|
21
|
+
> what makes Elm packages stick out more is not its reliability, but its design
|
|
22
|
+
> philosophy. So we put the design philosophy as the first section after the
|
|
23
|
+
> initial introduction.
|
|
24
|
+
>
|
|
25
|
+
> Writing out explicit design goals is a great idea even before you write any code
|
|
26
|
+
> (of course you can always revise them). They serve as:
|
|
27
|
+
>
|
|
28
|
+
> - A reminder to the package author of the core principles during design
|
|
29
|
+
> iteration
|
|
30
|
+
> - A clear statement of goals to help users decide whether the library is a good
|
|
31
|
+
> fit for them
|
|
32
|
+
> - A reference point for conversations about feature requests that helps ground
|
|
33
|
+
> the conversation in the basic goals of the library. This makes for a much more
|
|
34
|
+
> empathetic conversation (for example, someone could have a great idea that's
|
|
35
|
+
> not inline with the design goals of a library... in that case, perhaps a new
|
|
36
|
+
> library could be created, OR a different solution could be considered that
|
|
37
|
+
> honors the design goals of the library)
|
|
38
|
+
|
|
39
|
+
## Overview
|
|
40
|
+
|
|
41
|
+
**Document the most common usage of your package with a code sample and BRIEF
|
|
42
|
+
explanation.**
|
|
43
|
+
|
|
44
|
+
## Usage
|
|
45
|
+
|
|
46
|
+
**Provide more documentation about the use of your package.**
|
|
47
|
+
|
|
48
|
+
### NPM Package
|
|
49
|
+
|
|
50
|
+
This package relies on external
|
|
51
|
+
styles.
|
|
52
|
+
|
|
53
|
+
Install the package from NPM using the following command.
|
|
54
|
+
|
|
55
|
+
```sh
|
|
56
|
+
npm install --save-dev @curtissimo/elm-split-pane
|
|
57
|
+
```
|
|
58
|
+
|
|
59
|
+
Then, as part of your build process, include the external
|
|
60
|
+
styles.
|
|
61
|
+
|
|
62
|
+
To include the CSS, use the following import.
|
|
63
|
+
|
|
64
|
+
```css
|
|
65
|
+
@import url(@curtissimo/elm-split-pane/main.css);
|
|
66
|
+
```
|
package/package.json
ADDED
|
@@ -0,0 +1,39 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@curtissimo/elm-split-pane",
|
|
3
|
+
"version": "1.0.0-alpha.0",
|
|
4
|
+
"main": "./build/scripts/main.js",
|
|
5
|
+
"files": [
|
|
6
|
+
"./build/scripts/main.js.map",
|
|
7
|
+
"./build/styles/main.css",
|
|
8
|
+
"./build/styles/main.css.map"
|
|
9
|
+
],
|
|
10
|
+
"description": "A nestable split pane for Elm.",
|
|
11
|
+
"devDependencies": {
|
|
12
|
+
"@curtissimo/elm-hot": "latest",
|
|
13
|
+
"@parcel/transformer-elm": "latest",
|
|
14
|
+
"concurrently": "^9.2.1",
|
|
15
|
+
"elm": "^0.19.1-6",
|
|
16
|
+
"elm-doc-preview": "^6.0.1",
|
|
17
|
+
"elm-format": "^0.8.8",
|
|
18
|
+
"elm-json": "^0.2.13",
|
|
19
|
+
"elm-review": "^2.13.5",
|
|
20
|
+
"elm-test": "^0.19.1-revision17",
|
|
21
|
+
"elm-verify-examples": "^6.0.3",
|
|
22
|
+
"parcel": "latest"
|
|
23
|
+
},
|
|
24
|
+
"scripts": {
|
|
25
|
+
"build:assets": "parcel build assets/styles/main.css --dist-dir build",
|
|
26
|
+
"build:examples": "parcel build examples/src/index.html --dist-dir public",
|
|
27
|
+
"git:set-remote": "npm run git:set-remote:ssh",
|
|
28
|
+
"git:set-remote:http": "git remote add origin https://gitlab.com/curtissimo/elm-split-pane.git",
|
|
29
|
+
"git:set-remote:ssh": "git remote add origin git@gitlab.com:curtissimo/elm-split-pane.git",
|
|
30
|
+
"docs": "elm-doc-preview",
|
|
31
|
+
"lint:format": "elm-format --validate src",
|
|
32
|
+
"lint:review": "elm-review",
|
|
33
|
+
"start": "parcel ./examples/src/index.html --dist-dir .development",
|
|
34
|
+
"postinstall": "node ./patch-elm-hot.mjs",
|
|
35
|
+
"test:docs": "elm-verify-examples --run-tests"
|
|
36
|
+
},
|
|
37
|
+
"author": "Curtis Schlak <696163-realistschuckle@users.noreply.gitlab.com>",
|
|
38
|
+
"license": "MIT"
|
|
39
|
+
}
|