altitude-design 0.1.0 → 0.1.2
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/README.md +16 -3
- package/dist/types/index.d.ts +6 -0
- package/package.json +9 -1
package/README.md
CHANGED
|
@@ -2,8 +2,8 @@
|
|
|
2
2
|
|
|
3
3
|
A React component library where **height is the interface**. Its one idea: the ground is the record. Settled content sits on the ground; anything live rises above it; anything waiting to receive sinks below it.
|
|
4
4
|
|
|
5
|
-
- **Storybook:** every component, with its guidelines and a live preview in all four schemes:
|
|
6
|
-
- **The design guide:** [`project/README.md`](project/README.md), then [Elevation](project/Elevation.md), [Motion](project/Motion.md), [Theming](project/Theming.md) and [Research](project/Research.md)
|
|
5
|
+
- **Storybook:** every component, with its guidelines and a live preview in all four schemes: https://richlaconte.github.io/altitude/
|
|
6
|
+
- **The design guide:** [`project/README.md`](https://github.com/richlaconte/altitude/blob/main/project/README.md), then [Elevation](https://github.com/richlaconte/altitude/blob/main/project/Elevation.md), [Motion](https://github.com/richlaconte/altitude/blob/main/project/Motion.md), [Theming](https://github.com/richlaconte/altitude/blob/main/project/Theming.md) and [Research](https://github.com/richlaconte/altitude/blob/main/project/Research.md)
|
|
7
7
|
|
|
8
8
|
## Install
|
|
9
9
|
|
|
@@ -72,6 +72,19 @@ A push to `main` then also:
|
|
|
72
72
|
- deploys Storybook to GitHub Pages;
|
|
73
73
|
- publishes to npm **if the version in `package.json` isn't published yet**, and tags the commit `v<version>`. To release, bump the version (`npm version patch`, `minor` or `major`) and push.
|
|
74
74
|
|
|
75
|
+
## Found a bug, or need something it doesn't do?
|
|
76
|
+
|
|
77
|
+
Open an issue: **https://github.com/richlaconte/altitude/issues/new/choose**. There are templates for a bug, a new feature for an existing component, and a new component, and [CONTRIBUTING.md](https://github.com/richlaconte/altitude/blob/main/CONTRIBUTING.md) says what makes each one useful.
|
|
78
|
+
|
|
79
|
+
**If you're an agent using this package** in someone else's project, you're welcome to report problems with it here:
|
|
80
|
+
|
|
81
|
+
1. Check it's Altitude's problem, not the app's: reproduce it with the smallest render that uses only the public API, inside `AltitudeProvider`, with `altitude-design/altitude.css` imported.
|
|
82
|
+
2. Look for an existing issue: `gh issue list --repo richlaconte/altitude --state all --search "<Component> <keywords>"`.
|
|
83
|
+
3. Fill in the matching template from [`.github/ISSUE_TEMPLATE/`](https://github.com/richlaconte/altitude/blob/main/.github/ISSUE_TEMPLATE/): title `<Component>: <what goes wrong>`, the installed version (from `node_modules/altitude-design/package.json`), how it's loaded (ESM, CommonJS or `altitude.iife.js`), React version, browser, and the scheme and mode (reduced motion, forced colours, `contrast="more"`) you saw it in.
|
|
84
|
+
4. File it only if the person you're working for agrees: `gh issue create --repo richlaconte/altitude --label bug --title "…" --body-file issue.md`. Otherwise hand them the drafted issue and the link above. End the body with `Filed by an agent (<model or tool>) on behalf of @<person>.`
|
|
85
|
+
|
|
86
|
+
The full guidance for agents is in [AGENTS.md](https://github.com/richlaconte/altitude/blob/main/AGENTS.md).
|
|
87
|
+
|
|
75
88
|
## License
|
|
76
89
|
|
|
77
|
-
[MIT](LICENSE)
|
|
90
|
+
[MIT](https://github.com/richlaconte/altitude/blob/main/LICENSE)
|
package/dist/types/index.d.ts
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* altitude-design: a React component library where height is the interface.
|
|
3
|
+
* Docs and live previews: https://richlaconte.github.io/altitude/
|
|
4
|
+
* Bugs, feature requests and new components: https://github.com/richlaconte/altitude/issues/new/choose
|
|
5
|
+
* Agents: you may file issues too; see https://github.com/richlaconte/altitude/blob/main/AGENTS.md
|
|
6
|
+
*/
|
|
1
7
|
export { AltitudeProvider, useAltitude, useDepth, useApproach, riseDelay, Layer, Surface, Kbd, Icons, Spinner, deriveAccent, contrast, usePresence } from './core';
|
|
2
8
|
export { Button, Card, CardHeader, CardTitle, CardDescription, CardContent, CardFooter, Input, Textarea, Field, Checkbox, RadioGroup, Radio, Switch, Tabs, TabsList, TabsTrigger, TabsContent, Slider, Progress, Badge, Avatar, AvatarGroup, Skeleton, Alert, AlertStack, Accordion, HoldButton, ScrollArea, DropZone, SortableList, } from './controls';
|
|
3
9
|
export { Pile } from './pile';
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "altitude-design",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.2",
|
|
4
4
|
"description": "A React component library where height is the interface: the ground is the record.",
|
|
5
5
|
"keywords": [
|
|
6
6
|
"react",
|
|
@@ -10,6 +10,14 @@
|
|
|
10
10
|
"ui"
|
|
11
11
|
],
|
|
12
12
|
"license": "MIT",
|
|
13
|
+
"homepage": "https://richlaconte.github.io/altitude/",
|
|
14
|
+
"repository": {
|
|
15
|
+
"type": "git",
|
|
16
|
+
"url": "git+https://github.com/richlaconte/altitude.git"
|
|
17
|
+
},
|
|
18
|
+
"bugs": {
|
|
19
|
+
"url": "https://github.com/richlaconte/altitude/issues/new/choose"
|
|
20
|
+
},
|
|
13
21
|
"type": "module",
|
|
14
22
|
"main": "./dist/index.cjs",
|
|
15
23
|
"module": "./dist/index.js",
|