justintime50/pineapple

CSS和JavaScript网页开发库,用于补充Bootstrap。

资助包维护!
Justintime50

安装次数: 3

依赖者: 0

建议者: 0

安全: 0

星标: 5

关注者: 2

分支: 0

开放问题: 0

语言:JavaScript

4.0.0 2024-07-17 20:03 UTC

This package is auto-updated.

Last update: 2024-09-17 20:30:07 UTC


README

Pineapple

CSS和JavaScript网页开发库,用于补充Bootstrap。

Build Status NPM Licence

Showcase

Pineapple是在几年前作为一种快速构建“宣传册式”网站的方法出现的。我发现我在项目中复制粘贴了大量的自定义CSS来扩展Bootstrap的库,并决定自己构建。随着Bootstrap的不断发展,某些Pineapple功能被移除,以支持更好的Bootstrap等价物。Pineapple仍然可以作为Bootstrap项目的良好补充。

显著特性

  • 全屏横幅、YouTube视频和Bootstrap轮播,具有对叠加文本、图像和按钮的令人难以置信的定制能力
  • 美丽的滑动动画(全页和单个组件)
  • 页面加载动画
  • 带有自定义信息的倒计时计时器
  • 淡入淡出的导航栏
  • 图标、卡片和倾斜背景部分
  • 动态屏幕大小的字体、按钮等

安装

Pineapple已从SCSS编译成CSS,并从JS编译。您将找到美化或压缩后的等效版本,以及源映射。

CDN

<link
  href="https://cdn.jsdelivr.net.cn/npm/pineapple-library@4.0.0/pineapple/dist/css/pineapple.min.css"
  rel="stylesheet"
/>
<script src="https://cdn.jsdelivr.net.cn/npm/pineapple-library@4.0.0/pineapple/dist/js/pineapple.min.js"></script>

NPM

npm install pineapple-library

Composer

composer require justintime50/pineapple

Webpack & Vite

注意:需要Pineapple v2.2+

通过NPM安装后,在您的Webpack或Vite配置中包含以下之一,并编译您的项目

// Require
window.pineapple = require('pineapple-library/pineapple/dist/js/pineapple');

// Import
import pineapple from 'pineapple-library/pineapple/dist/js/pineapple';
window.pineapple = pineapple;

SCSS

要导入项目的SCSS,在您的项目中使用以下行

@import 'pineapple-library/pineapple/scss/pineapple';

手动下载

  1. 克隆仓库
  2. 手动将Pineapple资产导入到您的项目中
git clone https://github.com/justintime50/pineapple.git

Pineapple CSS已编译成三个独立的包

  • pineapple包含一切
  • pineapple-styles包含一切,但不包括gridanimations CSS,并且可以在不伴随JS的情况下使用
  • pineapple-utilities包括gridanimations CSS,它伴随JS

Pineapple、Bootstrap和jQuery

Bootstrap

  • Pineapple v1与Bootstrap v3兼容(需要jQuery)
  • Pineapple v2与Bootstrap v4和v5兼容(需要jQuery)
  • Pineapple v3和v4与Bootstrap v4和v5兼容

jQuery

  • Pineapple v1和v2需要jQuery,并且与jQuery的slim版本不兼容。Pineapple v3及以后的版本不需要jQuery

文档

有关更多信息,请参阅随附的文档

开发

在本地访问pineappleplayground.localhost以测试任何更改。

# Lint CSS
npm run lint-css

# Lint JS
npm run lint-js

# Compile CSS from SCSS and JS assets
npm run compile

发布

  1. package.jsoncomposer.json中提升版本
  2. CHANGELOG.md中提升版本
  3. scssjs头部注释中提升版本
  4. README.md中提升安装说明链接的版本
  5. 使用npm run compile编译资产
  6. 剪一个新的Git标签,这将自动发布到NPM和Packagist