Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/9gustin/storify
https://github.com/9gustin/storify
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/9gustin/storify
- Owner: 9gustin
- Created: 2020-11-26T14:23:57.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-12-01T13:24:12.000Z (about 4 years ago)
- Last Synced: 2024-10-13T16:32:24.366Z (2 months ago)
- Language: TypeScript
- Size: 962 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# storify :D
stories for you react app
[](https://www.npmjs.com/package/storify) [](https://standardjs.com)
## v1:
NPM package that show stories in a line(ordered by relevance and date)
## URL
https://www.npmjs.com/package/@9gustin/storify-react
## How to use
Add package to your aplication
```bash
npm i @9gustin/storify-react
```
### Short
#### App.js
```JSX
import React from 'react';
import {Storify, useStorify} from '@9gustin/storify-react';
import '@9gustin/storify-react/dist/index.css'
import initialState from './data/stories.json';
function App() {
const { stories } = useStorify(initialState.stories);
return (
{console.log(user)}}/>
);
}
export default App;
```
### Detailed
Import the Storify component and custom hook
```JSX
import {Storify, useStorify} from '@9gustin/storify-react';
```
### useStorify (Custom Hook)
| Param | Type | Description |
| -------------- | ------- | --------------------------------------------------------- |
| initialStories | Story[] | represent the list of stories to start the state variable |
| Return | Type | Description |
| ---------- | ------------- | --------------------------------------------------------------------------------------------------------------- |
| stories | Story[] | represent the list of stories that are managed in the state, and you should pass it to the Storify component |
| addStories | Function:void | that function gives you the possibility to add stories, and that's rendered in the Storify component |
| setStories | Function:void | that function give you the possibility to set the list of stories, and that's rendered in the Storify component |
Use:
```JSX
const { stories, addStories, setStories } = useStorify(initialStories);
```
### Storify (Component)
| Prop Name | Type | Description |
| ------------------- | ------------- | ---------------------------------------------------------------------------------------- |
| imgSize | string | represent the size of story buttons, receive the css property "width"/"height" |
| stories | Story[] | represent the list of stories that the component should render |
| viewProfileCallback | Function:User | the function that would be called when the user wants to view an user profile |
| storyBorderColor | string | represent the color of story buttons borders, that receive the css property border-color |
Use:
```JSX
{console.log(user)}}/>
```
### Models
Story
| Property | Type | Description |
| --------- | ------ | -------------------------- |
| user | User | the owner of story |
| id | string | the identificator of story |
| createdAt | string | the creation date of story |
| imageUrl | number | the url of story image |
User
| Property | Type | Description |
| --------- | ------ | ------------------------------------------------------ |
| username | string | the identificator of a user |
| imageUrl | string | the url of user profile image |
| relevance | number | the stories are ordered firstly for the user relevance |
#### About the order of stories
The stories (in the timeline of stories are ordered by user's relevance, and after by createdAt property of story, the users with new stories are shown first). And when the user clicks to view stories from a user the that's are shown by date ascending(from older to newer)
### Import styles
```JSX
import '@9gustin/storify-react/dist/index.css'
```
## v1: to fix
- The time of image loading (show a icon)
- Scroll stories in pc
## Future releases:
- Next story automatically, with time/progress bar
- Save actual user in state
- take response to stories, with a custom callback
- Button "Add story" with a custom callback
- Custom stories(colors, to group of persons)
## License
MIT © [9gustin](https://github.com/9gustin)
#### To practice
- CSS modules(scss)
- Typescript
- Custom hooks
- Create react library