@anubra266/stickyreact - npm Package Compare versions

Comparing version 0.1.1-0 to 1.0.0

dist/index.d.ts

@@ -1,2 +0,2 @@
-import { ReactChildren, ReactElement, ReactNode } from 'react';
+import { ReactElement, ReactNode } from 'react';
 /**
@@ -7,3 +7,3 @@ * Make the element sticky
     as?: any;
-}): JSX.Element;
+} & any): JSX.Element;
 /**
@@ -24,5 +24,5 @@ * A section, in which <Sticky /> element element is observed
 declare function StickyViewport({ children, as, ...rest }: {
-    children: ReactChildren;
+    children: any;
     as?: any;
 }): JSX.Element;
 export { StickyViewport, StickyBoundary, Sticky };

package.json

 {
-  "version": "0.1.1-0",
+  "version": "1.0.0",
   "license": "MIT",
@@ -4,0 +4,0 @@ "main": "dist/index.js",

README.md

@@ -1,160 +0,158 @@
-# TSDX React User Guide
+# Sticky React
 
-Congrats! You just saved yourself hours of work by bootstrapping this project with TSDX. Let’s get you oriented with what’s here and how to use it.
+Create Sticky Elements in React
+[![NPM](https://img.shields.io/npm/v/@anubra266/stickyreact.svg)](https://www.npmjs.com/package/@anubra266/stickyreact) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
 
-> This TSDX setup is meant for developing React component libraries (not apps!) that can be published to NPM. If you’re looking to build a React-based app, you should use `create-react-app`, `razzle`, `nextjs`, `gatsby`, or `react-static`.
+## Install
 
-> If you’re new to TypeScript and React, checkout [this handy cheatsheet](https://github.com/sw-yx/react-typescript-cheatsheet/)
-
-## Commands
-
-TSDX scaffolds your new library inside `/src`, and also sets up a [Parcel-based](https://parceljs.org) playground for it inside `/example`.
-
-The recommended workflow is to run TSDX in one terminal:
-
 ```bash
-npm start # or yarn start
+npm install --save @anubra266/stickyreact
+#OR
+yarn add @anubra266/stickyreact
 ```
 
-This builds to `/dist` and runs the project in watch mode so any edits you save inside `src` causes a rebuild to `/dist`.
+## Usage
 
-Then run the example inside another:
+```javascript
+import Component from 'my-project';
 
-```bash
-cd example
-npm i # or yarn to install dependencies
-npm start # or yarn start
-```
+function App() {
+  const handleStuck = target => {
+    target?.classList.add('stuck');
+  };
 
-The default example imports and live reloads whatever is in `/dist`, so if you are seeing an out of date component, make sure TSDX is running in watch mode like we recommend above. **No symlinking required**, we use [Parcel's aliasing](https://parceljs.org/module_resolution.html#aliases).
+  const handleUnstuck = target => {
+    target?.classList.remove('stuck');
+  };
 
-To do a one-off build, use `npm run build` or `yarn build`.
+  const handleChange = ({ target, type }) => {
+    if (type === 'stuck') {
+      target?.classList.add('stuck');
+    } else {
+      target?.classList.remove('stuck');
+    }
+  };
+  return (
+    <StickyViewport as="div">
+      <StickyBoundary
+        onStuck={handleStuck}
+        onUnstuck={handleUnstuck}
+        onChange={handleChange}
+      >
+        <Sticky> I'm Sticky </Sticky>
+        <div> I'm not Sticky </div>
+        <div> I'm not Sticky too </div>
+      </StickyBoundary>
+      <StickyBoundary
+        onStuck={handleStuck}
+        onUnstuck={handleUnstuck}
+        onChange={handleChange}
+      >
+        <Sticky>
+          I'm also Sticky, but I override the above once I'm scrolled to
+        </Sticky>
+        <div> I'm not Sticky </div>
+        <div> I'm not Sticky too </div>
+      </StickyBoundary>
+    </StickyViewport>
+  );
+}
+```
 
-To run tests, use `npm test` or `yarn test`.
+## API Reference
 
-## Configuration
+#### StickyViewport
 
-Code quality is set up for you with `prettier`, `husky`, and `lint-staged`. Adjust the respective fields in `package.json` accordingly.
+Wrapper and Provider for Sticky App
 
-### Jest
+```javascript
+<StickyViewport>...</StickyViewport>
+```
 
-Jest tests are set up to run with `npm test` or `yarn test`.
+| Parameter | Type                       | Description                   | Required | Deffault |
+| :-------- | :------------------------- | :---------------------------- | -------- | -------- |
+| `as`      | `string` or `ReactElement` | React Element used in display | false    | `div`    |
 
-### Bundle analysis
+#### StickyBoundary
 
-Calculates the real cost of your library using [size-limit](https://github.com/ai/size-limit) with `npm run size` and visulize it with `npm run analyze`.
+Container that wraps each Sticky Element
 
-#### Setup Files
-
-This is the folder structure we set up for you:
-
-```txt
-/example
-  index.html
-  index.tsx       # test your component here in a demo app
-  package.json
-  tsconfig.json
-/src
-  index.tsx       # EDIT THIS
-/test
-  blah.test.tsx   # EDIT THIS
-.gitignore
-package.json
-README.md         # EDIT THIS
-tsconfig.json
+```javascript
+<StickyBoundary>...</StickyBoundary>
 ```
 
-#### React Testing Library
+| Parameter   | Type                       | Description                                     | Required | Deffault |
+| :---------- | :------------------------- | :---------------------------------------------- | -------- | -------- |
+| `as`        | `string` or `ReactElement` | React Element used in display                   | false    | `div`    |
+| `onStuck`   | (target)=>void             | Callback when a child becomes Sticky            | false    | -------- |
+| `onUnstuck` | (target)=>void             | Callback when a child is no longer Sticky       | false    | -------- |
+| `onChange`  | ({target,type})=>void      | Callback when a child changes it's Sticky State | false    | -------- |
 
-We do not set up `react-testing-library` for you yet, we welcome contributions and documentation on this.
+#### Sticky
 
-### Rollup
+Makes it's content Sticky
 
-TSDX uses [Rollup](https://rollupjs.org) as a bundler and generates multiple rollup configs for various module formats and build settings. See [Optimizations](#optimizations) for details.
+```javascript
+<Sticky>...</Sticky>
+```
 
-### TypeScript
+| Parameter | Type                       | Description                   | Required | Deffault |
+| :-------- | :------------------------- | :---------------------------- | -------- | -------- |
+| `as`      | `string` or `ReactElement` | React Element used in display | false    | `div`    |
 
-`tsconfig.json` is set up to interpret `dom` and `esnext` types, as well as `react` for `jsx`. Adjust according to your needs.
+#### onStuck
 
-## Continuous Integration
+Callback when a child becomes Sticky.
 
-### GitHub Actions
+```js
+(target: ReactNode) => {
+  target?.classList.add('stuck');
+};
+```
 
-Two actions are added by default:
+| Parameter | Type        | Description                 |
+| :-------- | :---------- | :-------------------------- |
+| `target`  | `ReactNode` | The Sticky Element Instance |
 
-- `main` which installs deps w/ cache, lints, tests, and builds on all pushes against a Node and OS matrix
-- `size` which comments cost comparison of your library on every pull request using [`size-limit`](https://github.com/ai/size-limit)
+#### onUnstuck
 
-## Optimizations
+Callback when a child is no longer Sticky.
 
-Please see the main `tsdx` [optimizations docs](https://github.com/palmerhq/tsdx#optimizations). In particular, know that you can take advantage of development-only optimizations:
-
 ```js
-// ./types/index.d.ts
-declare var __DEV__: boolean;
-
-// inside your code...
-if (__DEV__) {
-  console.log('foo');
-}
+(target: ReactNode) => {
+  target?.classList.remove('stuck');
+};
 ```
 
-You can also choose to install and use [invariant](https://github.com/palmerhq/tsdx#invariant) and [warning](https://github.com/palmerhq/tsdx#warning) functions.
+| Parameter | Type        | Description                 |
+| :-------- | :---------- | :-------------------------- |
+| `target`  | `ReactNode` | The Sticky Element Instance |
 
-## Module Formats
+#### onChange
 
-CJS, ESModules, and UMD module formats are supported.
+Callback when a child becomes Sticky or Losesthe Sticky State.
 
-The appropriate paths are configured in `package.json` and `dist/index.js` accordingly. Please report if any issues are found.
+**NB:** It provides a destructurable parameter
 
-## Deploying the Example Playground
-
-The Playground is just a simple [Parcel](https://parceljs.org) app, you can deploy it anywhere you would normally deploy that. Here are some guidelines for **manually** deploying with the Netlify CLI (`npm i -g netlify-cli`):
-
-```bash
-cd example # if not already in the example folder
-npm run build # builds to dist
-netlify deploy # deploy the dist folder
+```js
+({ target, type }: { target: ReactNode, type: 'stuck' | 'unstuck' }) => {
+  if (type === 'stuck') {
+    target?.classList.add('stuck');
+  } else {
+    target?.classList.remove('stuck');
+  }
+};
 ```
 
-Alternatively, if you already have a git repo connected, you can set up continuous deployment with Netlify:
+**NB:** The paramters are to be destructured
 
-```bash
-netlify init
-# build command: yarn build && cd example && yarn && yarn build
-# directory to deploy: example/dist
-# pick yes for netlify.toml
-```
+| Parameter | Type                  | Description                 |
+| :-------- | :-------------------- | :-------------------------- |
+| `target`  | `ReactNode`           | The Sticky Element Instance |
+| `type`    | `'stuck' | 'unstuck'` | The Sticky Element Instance |
 
-## Named Exports
+## Used By
 
-Per Palmer Group guidelines, [always use named exports.](https://github.com/palmerhq/typescript#exports) Code split inside your React app instead of your React library.
+This project is used by the following Projects:
 
-## Including Styles
-
-There are many ways to ship styles, including with CSS-in-JS. TSDX has no opinion on this, configure how you like.
-
-For vanilla CSS, you can include it at the root directory and add it to the `files` section in your `package.json`, so that it can be imported separately by your users and run through their bundler's loader.
-
-## Publishing to NPM
-
-We recommend using [np](https://github.com/sindresorhus/np).
-
-## Usage with Lerna
-
-When creating a new package with TSDX within a project set up with Lerna, you might encounter a `Cannot resolve dependency` error when trying to run the `example` project. To fix that you will need to make changes to the `package.json` file _inside the `example` directory_.
-
-The problem is that due to the nature of how dependencies are installed in Lerna projects, the aliases in the example project's `package.json` might not point to the right place, as those dependencies might have been installed in the root of your Lerna project.
-
-Change the `alias` to point to where those packages are actually installed. This depends on the directory structure of your Lerna project, so the actual path might be different from the diff below.
-
-```diff
-   "alias": {
--    "react": "../node_modules/react",
--    "react-dom": "../node_modules/react-dom"
-+    "react": "../../../node_modules/react",
-+    "react-dom": "../../../node_modules/react-dom"
-   },
-```
-
-An alternative to fixing this problem would be to remove aliases altogether and define the dependencies referenced as aliases as dev dependencies instead. [However, that might cause other problems.](https://github.com/palmerhq/tsdx/issues/64)
+- [Choc UI](https://choc-ui.tech) - Site search bar

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No v1

Quality

Package is not semver >=1. This means it is not stable and does not support ^ ranges.

Found 1 instance in 1 package

Improved metrics

Number of low quality alerts

2

decreased by-33.33%

Worsened metrics

Total package byte prevSize

103821

decreased by-1.72%

Lines of code

1112

decreased by-0.09%

Number of lines in readme file

159

decreased by-1.24%

No dependency changes