Skip to content

Commit

Permalink
initial
Browse files Browse the repository at this point in the history
  • Loading branch information
martrapp committed Nov 23, 2024
1 parent 2ae6a1d commit 0d43136
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 29 deletions.
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: GitHub Discussions
url: https://github.com/vtbag/cam-shaft/discussions
url: https://github.com/vtbag/utensil-drawer/discussions
about: Does the issue involve a lot of explanation, or are you not sure how it can be split into actionable tasks? Consider starting a discussion first.
2 changes: 1 addition & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ concurrency: ${{ github.workflow }}-${{ github.ref }}

jobs:
release:
if: github.repository == 'vtbag/cam-shaft'
if: github.repository == 'vtbag/utensil-drawer'
permissions:
contents: write
pull-requests: write
Expand Down
14 changes: 1 addition & 13 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,2 @@
# @vtbag/cam-shaft
# @vtbag/utensil-drawer

## 1.0.1 - 2024-10-17

### Patch Changes

- 35e430e: Updates dependencies
- 0c1f959: Adds .d.ts declarations

## 1.0.0 - 2024-10-04

### Major Changes

- 1d33171: Initial revision
19 changes: 9 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,25 +1,24 @@
[⭐️Please star to support this work⭐️](https://github.com/vtbag/cam-shaft)
[⭐️Please star to support this work⭐️](https://github.com/vtbag/utensil-drawer)

# 🐫 The Cam-Shaft
# 🛠 The Utensil Drawer

Cam-Shaft: Bump your view transition pseudo-elements into place to avoid that unexpected pseudo-smooth-scrolling effect.
Utensil Drawer: Pull out just the functions you need to craft seamless transitions.

![Build Status](https://github.com/vtbag/cam-shaft/actions/workflows/run-build.yml/badge.svg)
[![npm version](https://img.shields.io/npm/v/@vtbag/cam-shaft/latest)](https://www.npmjs.com/package/@vtbag/cam-shaft)
![minzip](https://badgen.net/bundlephobia/minzip/@vtbag/cam-shaft)
[![NPM Downloads](https://img.shields.io/npm/dw/@vtbag/cam-shaft)](https://www.npmjs.com/package/@vtbag/cam-shaft)
![Build Status](https://github.com/vtbag/utensil-drawer/actions/workflows/run-build.yml/badge.svg)
[![npm version](https://img.shields.io/npm/v/@vtbag/utensil-drawer/latest)](https://www.npmjs.com/package/@vtbag/utensil-drawer)
![minzip](https://badgen.net/bundlephobia/minzip/@vtbag/utensil-drawer)
[![NPM Downloads](https://img.shields.io/npm/dw/@vtbag/utensil-drawer)](https://www.npmjs.com/package/@vtbag/utensil-drawer)

The @vtbag website can be found at https://vtbag.dev/

## !!! News !!!

Dependency updates

For details see the [CHANGELOG](https://github.com/vtbag/cam-shaft/blob/main/CHANGELOG.md)
For details see the [CHANGELOG](https://github.com/vtbag/utensil-drawer/blob/main/CHANGELOG.md)


## What is it?

When you assign a `view-transition-name` to an element that is larger than the viewport, the View Transition API adds a default animation to the `::view-transition-group()` of the element that makes instant scrolling look like smooth scrolling. The Cam-Shaft bumps and nudges your view transition pseudo-elements back into place to avoid that pseudo-smooth-scrolling effect.
The Utensil Drawer holds reusable functions to help you build websites with view transitions. It is a bit sparse right now, but like the one in your kitchen, it is bound to fill up over time.

[See the Cam-Shaft in action](https://vtbag.dev/shaft-demo2/1/) and [see how it can be used in your own projects](https://vtbag.dev/tools/cam-shaft/).
8 changes: 4 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
{
"name": "@vtbag/cam-shaft",
"name": "@vtbag/utensil-drawer",
"type": "module",
"version": "1.0.1",
"main": "lib/index.js",
"description": "The Cam-Shaft bumps your view transition images into place to avoid the pseudo-smooth-scroll effect when applying view transitions to elements that are taller than the viewport.",
"description": "Pull out just what you need to craft seamless transitions. The Utensil Drawer holds reusable functions to help you build websites with view transitions. It is a bit sparse right now, but like the one in your kitchen, it is bound to fill up over time.",
"files": [
"lib/index.js",
"lib/index.d.ts"
Expand All @@ -21,7 +21,7 @@
},
"repository": {
"type": "git",
"url": "git+https://github.com/vtbag/cam-shaft.git"
"url": "git+https://github.com/vtbag/utensil-drawer.git"
},
"keywords": [
"view",
Expand All @@ -38,7 +38,7 @@
"author": "vtbag",
"license": "ISC",
"bugs": {
"url": "https://github.com/vtbag/cam-shaft/issues"
"url": "https://github.com/vtbag/utensil-drawer/issues"
},
"homepage": "https://vtbag.dev",
"funding": {
Expand Down

0 comments on commit 0d43136

Please sign in to comment.