react-basic-items-pagination
v1.1.2
Published
It's a component helper for rendering set of items and manage the interaction with them
Downloads
4
Readme
React Basic Items Pagination
A LightWeight component helper in React developement
The appearance of Items is a common thing in WebSites, you can't find any E-commerce website without a list of articles to purchase, if you know the importance of this then take a look at this helper. Now it's possible in an easy way to create a set of items and costumize them according to your website 😁 , you have a project or work inside an organization , you want to save time or help your team , you can use this free helper to create an awesome set of items in less than one minute ! Click me to see a demonstration ✋ ! Let's Begin 😎 !
Table of Contents
Introduction
Take a Look of the result of this awesome component helper ! ( I've choosed the pictures below to illustrate my example because I'm an anime lover 🤣 🤣 🤣 )
► Specifications :
• Easy to use 😉 • Full style customization ✂️ • Place it anywhere in your code, it'll work 🎯 • All Browsers(IE, Firefox, Chrome ...) Support 🚀
► Actual & Upcoming Features :
☑️ Rendering Responsively the set of Items ☑️ Full Overriding Styles of Elements ⏹️ Multiple Displaying Modes (Choosing title/image positions) ⏹️ Supporting Fetching data by a given url ⏹️ Pagination & Lazy loading on fetching data ⏹️ Supporting Items that display media (video, gifs ...)
Getting Started
It's simple whether you are a newbie or expert with React, just by following the instructions below you'll be able to use this library and do this cool stuff !
► Prerequisites
Since you are working with react, it's fine you'll not need to install any other dependancy, 'React >= 16.0' is the only dependancy of this helper 🤗.
► Installing
This package is available in npm repository as react-basic-items-pagination.
npm install react-basic-items-pagination --save
Or by Using Yarn.
yarn add react-basic-items-pagination --save
Now wherever you want in your project, you can import it
import BasicItemsPagination from 'react-basic-items-pagination';
► Example
It's so simple ;) , now it's ready to use just by calling the tag of BasicItemsPagination ; For more clarification ↓↓↓ check the example below ↓↓↓ The sample code :
<BasicItemsPagination
height={400} // height of each Item
verticalSpacing={5} // The space of Items Vertically
horizontalSpacing={5} // The space of Items Horizontally
itemsPerRow={2} // Number of Items in each row of the page
itemsNumber={4} // Number of Items in each page
withImage // Whether the Item contain Image or not
data={mockedData} // We Provide Data that contain the title , description and image url of the items
imageStyle={ // We can choose the rate size of image contained in each Item
{
"heightRate": 100,
"widthRate": 50
}
}
childrenContent={ // Wanna add some button for action or whatever, add it here !
(item) => {
<div>
Whatever you want ;) !
{item.id} // You'll need the item object for some actions
</div>
}
}
/>
The format of Data :
import HxHBoss from `${your-path}/img/HxH-boss.jpg`;
import LawKid from `${your-path}/img/Law-Kid.jpg`;
import LuffyQuote from `${your-path}/img/Luffy-Punch-Line.jpg`;
import PirateKings from `${your-path}/img/Pirate-Kings.jpg`;
mockedData = [
{
"title": "HxH Boss",
"image": HxHBoss,
"description": "The boss of spider bands in HunterXHunter"
},
{
"title": "Trafalgaw Law Kid",
"image": LawKid,
"description": "Law Holding his Ope-Ope Devil Fruit"
},
{
"title": "Luffy Quote",
"image": LuffyQuote,
"description": "If you don't take risks !\nYou can't create A Future !\nDamn Right :D !"
},
{
"title": "One Piece Pirate Kings",
"image": PirateKings,
"description": "Luffy , Roger and Rayleigh !\n Such Epicness in one picture !"
}
];
The output result :
► More Costumizing
<BasicItemsPagination
....
verticalSpacing={4}
horizontalSpacing={4}
....
imageStyle={
{
"heightRate": 100,
"widthRate": 50,
"borderTopLeftRadius": "10px",
"borderBottomLeftRadius": "10px",
"boxShadow": "4px 0px 5px 1px gray"
}
}
boxStyle={
{
"borderRadius": "10px",
"boxShadow": "0px 0px 10px 0px"
}
}
The output result :
Authors
- Boumhicha El Mehdi - Initial work - Elmehdibm
License
This project is licensed under the MIT License - see the LICENSE.md file for details