[](https://chrome.google.com/webstore) [](https://opensource.org/licenses/MIT) [](https://github.com/khabzox/ytb-shorts-blocker/actions) [](https://www.typescriptlang.org/)
[](https://chrome.google.com/webstore) [](https://chrome.google.com/webstore) [](https://chrome.google.com/webstore) [](https://github.com/khabzox/ytb-shorts-blocker/stargazers) [](https://github.com/khabzox/ytb-shorts-blocker/issues) [](https://github.com/khabzox/ytb-shorts-blocker/network)
## 🚀 Quick Start
### 📦 **Install as Library (For Developers)**
```bash
# Using npm
npm install @khabzox/ytb-shorts-blocker
# Using bun
bun add @khabzox/ytb-shorts-blocker
# Using yarn
yarn add @khabzox/ytb-shorts-blocker
```
### 🔧 **Usage in Your Project**
#### **Basic Usage (Simple Integration)**
```typescript
import { initYouTubeShortsBlocker } from 'ytb-shorts-blocker';
// Start blocking YouTube Shorts immediately
initYouTubeShortsBlocker();
```
#### **Advanced Usage (Custom Configuration)**
```typescript
import {
initYouTubeShortsBlocker,
updateSettings,
setEnabled,
getSettings
} from 'ytb-shorts-blocker';
// Initialize with custom settings
initYouTubeShortsBlocker({
enabled: true,
blockingMode: 'hide',
showNotifications: true,
blockInSearch: true,
blockInHome: true,
blockInSubscriptions: true,
blockInTrending: false,
debugMode: false
});
// Update settings dynamically
updateSettings({
blockingMode: 'remove',
debugMode: true
});
// Enable/disable blocking
setEnabled(false);
// Get current settings
const settings = getSettings();
```
#### **Manual Control (Custom Implementation)**
```typescript
import {
detectShorts,
blockElement,
isYouTubePage,
isShortsPage
} from 'ytb-shorts-blocker';
// Check if we're on YouTube
if (isYouTubePage()) {
// Detect and block shorts manually
const shortsElements = detectShorts();
shortsElements.forEach(element => {
blockElement(element, 'hide');
});
}
```
### 🎯 **API Reference**
#### Core Functions
- `initYouTubeShortsBlocker(settings?)` - Initialize the blocker
- `setEnabled(enabled: boolean)` - Enable/disable blocking
- `setBlockingMode(mode: 'hide' | 'remove' | 'redirect')` - Set blocking mode
- `blockShorts()` - Manually block shorts on current page
- `getSettings()` - Get current settings
- `updateSettings(settings: Partial