Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 13 additions & 17 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,40 @@

# Raising an Issue

* Make sure the issue hasn't been raised yet
* Include **screenshots** or animated GIFs in your issue whenever needed (if visual issue)
- Make sure the issue hasn't been raised yet
- Include **screenshots** or animated GIFs in your issue whenever needed (if visual issue)

# Submitting a Pull Request

* The current developed version is in the ``main`` branch. The theme does not have a dedicated ``develop`` branch
* Include **screenshots** or animated GIFs in your pull request whenever needed (if visual changes)
* It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging
* **DO NOT** commit the ``dist`` folder, use it only for testing on your end
* If adding new feature:
* Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it

- The current developed version is in the `main` branch. The theme does not have a dedicated `develop` branch
- Include **screenshots** or animated GIFs in your pull request whenever needed (if visual changes)
- It's OK to have multiple small commits as you work on the PR - we will let GitHub automatically squash it before merging
- **DO NOT** commit the `dist` folder, use it only for testing on your end
- If adding new feature:
- Provide convincing reason to add this feature. Ideally you should open a suggestion issue first and have it greenlighted before working on it

## Oruga Sass styleguide

* **Always on a separated file** in ``/src/scss/components``
* **Use .scss extension**
* **Use kebab-case**

- **Always on a separated file** in `/src/scss/components`
- **Use .scss extension**
- **Use kebab-case**

# Development Setup

You need at least [Node.js](http://nodejs.org/) **version 22**.
The local setup contains every example of the main Oruga documentation page.
The local setup contains every example of the main Oruga documentation page.

After cloning the repository, install the dependencies:

```bash
$ npm install
```


## Link the main repo locally

To link the main Oruga packages locally, build both the `oruga` and the `examples` package in the Oruga repo.
Then run `npm run link ../oruga/packages/oruga ../oruga/packages/examples` in the theme repo to link the build output of the main Oruga packages.


## Common NPM scripts

To compile the code in watch mode and run the live server on [http://localhost:5173](http://localhost:5173):
Expand All @@ -64,4 +60,4 @@ $ npm run lint

# lint the css/scss code
$ npm run lint:style
```
```
1 change: 0 additions & 1 deletion .github/FUNDING.yml
Original file line number Diff line number Diff line change
@@ -1,2 +1 @@
# These are supported funding model platforms

5 changes: 2 additions & 3 deletions .github/ISSUE_TEMPLATE/BUG_REPORT.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
---
name: Bug report
about: Create a report to help us improve Bootstrap theme for Oruga
labels:
labels:
---

<!-- PLEASE READ THE FOLLOWING INSTRUCTIONS -->


### Overview of the problem

**Theme** version: [X.X.X]
Expand All @@ -31,4 +30,4 @@ labels:

### Actual behavior

<!--What actually happened-->
<!--What actually happened-->
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/FEATURE_REQUEST.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ labels: feature request

### Why Oruga need this feature

<!--Explain why Oruga needs it-->
<!--Explain why Oruga needs it-->
4 changes: 2 additions & 2 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Build Theme
on:
push:
branches:
branches:
- develop
- main
pull_request:
Expand All @@ -19,7 +19,7 @@ jobs:
uses: actions/setup-node@v4
with:
node-version: 20.x
registry-url: 'https://registry.npmjs.org'
registry-url: "https://registry.npmjs.org"
- name: Install dependencies 📦
run: npm install
- name: Run build lib 🛠️
Expand Down
25 changes: 25 additions & 0 deletions .github/workflows/lint-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Lint Check
on:
push:
branches:
- main
- develop
pull_request:
branches:
- main
- develop
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 22.x
registry-url: "https://registry.npmjs.org"
cache: "npm"
- name: Install dependencies 📦
run: npm ci
- name: Run lint check 🧐
run: npm run test:lint
6 changes: 3 additions & 3 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,13 +10,13 @@ jobs:
- name: Use Node.js '20.x'
uses: actions/setup-node@v4
with:
node-version: '20.x'
registry-url: 'https://registry.npmjs.org'
node-version: "20.x"
registry-url: "https://registry.npmjs.org"
- name: Install dependencies 📦
run: npm install
- name: Build lib 🛠️
run: npm run build
- name: Publish NPM lib 📋
run: npm publish
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
28 changes: 14 additions & 14 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,22 @@ appearance, race, religion, or sexual identity and orientation.
Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or
advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic
address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Expand Down Expand Up @@ -73,4 +73,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
[homepage]: https://www.contributor-covenant.org

For answers to common questions about this code of conduct, see
https://www.contributor-covenant.org/faq
https://www.contributor-covenant.org/faq
37 changes: 17 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
</a>
</p>


### Install

```sh
Expand All @@ -40,22 +39,21 @@ yarn add @oruga-ui/theme-bootstrap
### Configure

```js
import { createApp } from 'vue'
import App from './App.vue'
import { createApp } from "vue";
import App from "./App.vue";

// import Oruga
import Oruga from '@oruga-ui/oruga-next'
import Oruga from "@oruga-ui/oruga-next";

// import Oruga Bootstrap theme config
import { bootstrapConfig } from '@oruga-ui/theme-bootstrap'
import { bootstrapConfig } from "@oruga-ui/theme-bootstrap";

// import Bootstrap and Oruga styling
import '@oruga-ui/theme-bootstrap/dist/bootstrap.css'
import "@oruga-ui/theme-bootstrap/dist/bootstrap.css";

createApp(App)
.use(Oruga, bootstrapConfig)
.mount('#app')
createApp(App).use(Oruga, bootstrapConfig).mount("#app");
```

Please note, this package can be used without importing any other Oruga styling or theme.

### Customization (SASS/SCSS)
Expand Down Expand Up @@ -106,30 +104,29 @@ You have two options for including the theme: include all the styling at once (i

### Override default config

In case you want to replace the default style of a component you can override or add new classes changing ``bootstrapConfig``; more details about components customization on https://oruga.io/documentation/#customization
In case you want to replace the default style of a component you can override or add new classes changing `bootstrapConfig`; more details about components customization on https://oruga.io/documentation/#customization

```js
import { createApp } from 'vue'
import { createApp } from "vue";

import Oruga from '@oruga-ui/oruga-next'
import { bootstrapConfig } from '@oruga-ui/theme-bootstrap'
import Oruga from "@oruga-ui/oruga-next";
import { bootstrapConfig } from "@oruga-ui/theme-bootstrap";

import '@oruga-ui/theme-bootstrap/dist/bootstrap.css'
import "@oruga-ui/theme-bootstrap/dist/bootstrap.css";

const custombootstrapConfig = {
...bootstrapConfig,
checkbox: {
override: true,
rootClass: 'checkbox'
}
}
rootClass: "checkbox",
},
};

createApp(App)
.use(Oruga, custombootstrapConfig)
.mount('#app')
createApp(App).use(Oruga, custombootstrapConfig).mount("#app");
```

## Contributors

Thank you to everyone involved for improving this project, day by day 💚

<a href="https://github.com/oruga-ui/theme-bootstrap">
Expand Down
38 changes: 19 additions & 19 deletions eslint.config.mjs
Original file line number Diff line number Diff line change
@@ -1,60 +1,60 @@
/* eslint-env node */

import vuePlugin from "eslint-plugin-vue";
import eslint from "@eslint/js";
import { globalIgnores } from "eslint/config";
import prettierPlugin from "eslint-plugin-prettier/recommended";
import { includeIgnoreFile } from "@eslint/compat";
import vuePlugin from "eslint-plugin-vue";
import {
defineConfigWithVueTs,
vueTsConfigs,
} from "@vue/eslint-config-typescript";
// import vueA11yPlugin from "eslint-plugin-vuejs-accessibility";
import prettierConfig from "@vue/eslint-config-prettier";

import { includeIgnoreFile } from "@eslint/compat";
import path from "node:path";
import { fileURLToPath } from "node:url";
import path from "node:path";

const __filename = fileURLToPath(import.meta.url);
const __dirname = path.dirname(__filename);
const gitignorePath = path.resolve(__dirname, ".gitignore");

export default [
// add more generic rulesets here
// define specific ignore patterns
globalIgnores(["*.d.ts"]),

// include ignore .gitignore patterns
globalIgnores(["**/.*", "**/dist/**", "**/build/**"]),
// include .gitignore ignore patterns
includeIgnoreFile(gitignorePath),

// add js configs
eslint.configs.recommended,

// add vue with ts configs
...defineConfigWithVueTs(
vuePlugin.configs["flat/recommended"],
vueTsConfigs.recommended,
),

// add vue a11y configs
// ...vueA11yPlugin.configs["flat/recommended"],

// add prettier configs
prettierPlugin,
prettierConfig,

// your modifications
{
rules: {
// TypeScript
"@typescript-eslint/no-explicit-any": ["warn"],
"@typescript-eslint/ban-ts-comment": ["warn"],
"@typescript-eslint/explicit-function-return-type": ["warn"],
// Vue
"vue/padding-line-between-blocks": ["error", "always"],
"vue/multi-word-component-names": ["off"],
"vue/block-order": ["error", { order: ["script", "template", "style"] }],
"vue/block-lang": ["error", { script: { lang: "ts" } }],
"comma-dangle": ["error", "always-multiline"],
"prettier/prettier": [
"vue/html-closing-bracket-newline": [
"error",
{
trailingComma: "all",
endOfLine: "auto",
bracketSameLine: true,
singleline: "never",
multiline: "never",
selfClosingTag: {
singleline: "never",
multiline: "never",
},
},
],
},
Expand Down
2 changes: 1 addition & 1 deletion index.html
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<!DOCTYPE html>
<!doctype html>
<html lang="en">
<head>
<meta charset="UTF-8" />
Expand Down
Loading