{"id":14975452,"url":"https://github.com/andywer/jquery-dim-background","last_synced_at":"2025-10-27T13:30:51.635Z","repository":{"id":57282073,"uuid":"10076351","full_name":"andywer/jquery-dim-background","owner":"andywer","description":"jQuery plugin to dim the current page except for some user-defined top elements.","archived":false,"fork":false,"pushed_at":"2017-04-01T15:46:56.000Z","size":6133,"stargazers_count":44,"open_issues_count":1,"forks_count":4,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-10-30T08:03:47.480Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://andywer.github.io/jquery-dim-background/demo/basic.html","language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/andywer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-05-15T10:39:03.000Z","updated_at":"2024-07-03T01:46:09.000Z","dependencies_parsed_at":"2022-08-31T00:01:44.911Z","dependency_job_id":null,"html_url":"https://github.com/andywer/jquery-dim-background","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andywer%2Fjquery-dim-background","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andywer%2Fjquery-dim-background/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andywer%2Fjquery-dim-background/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/andywer%2Fjquery-dim-background/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/andywer","download_url":"https://codeload.github.com/andywer/jquery-dim-background/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236624389,"owners_count":19178981,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-09-24T13:52:03.373Z","updated_at":"2025-10-27T13:30:51.284Z","avatar_url":"https://github.com/andywer.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"jquery-dim-background\n=====================\n[![Build Status](https://travis-ci.org/andywer/jquery-dim-background.svg?branch=master)](https://travis-ci.org/andywer/jquery-dim-background) [![Bower version](https://badge.fury.io/bo/jquery-dim-background.svg)](http://badge.fury.io/bo/jquery-dim-background)\n [![Coverage Status](https://img.shields.io/coveralls/andywer/jquery-dim-background.svg)](https://coveralls.io/r/andywer/jquery-dim-background?branch=master)\n\njQuery plugin to dim the current page except for some user-defined top elements.\n\nUsage\n-----\n\nInclude the script in your website first. Add this script tag after your jQuery inclusion.\n\n```html\n\u003cscript type=\"text/javascript\" src=\"http://andywer.github.io/jquery-dim-background/jquery.dim-background.min.js\"\u003e\u003c/script\u003e\n```\n\n\nUsage is simple. You can dim your website, but keep some elements on top of the curtain:\n\n```html\n\u003cscript type=\"text/javascript\"\u003e\n    $('.myElements').dimBackground();\n\u003c/script\u003e\n```\n\n\nTo switch back to normal:\n\n```html\n\u003cscript type=\"text/javascript\"\u003e\n    $('.myElements').undim();\n    // - or -\n    $.undim();\n\u003c/script\u003e\n```\n\n\nYou can also provide a callback function that is called when the animation completes and you can overwrite default options:\n\n(You may find the available options in the `jquery.dim-background.js` file. Have a look at `$.fn.dimBackground.defaults`)\n\n```html\n\u003cscript type=\"text/javascript\"\u003e\n    $('.myElements').dimBackground({\n        darkness : 0.8            // 0: no dimming, 1: completely black\n    }, function() {\n        // do something\n    });\n\u003c/script\u003e\n```\n\nDemo\n----\n\nHave a look at a [basic example](http://andywer.github.io/jquery-dim-background/demo/basic.html) that shows what this plugin does.\n\n\nLicense\n-------\n\nThis plugin is published under the MIT license. See [license](https://raw.github.com/andywer/jquery-dim-background/master/LICENSE.txt).\n\nHave a lot of fun!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandywer%2Fjquery-dim-background","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fandywer%2Fjquery-dim-background","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fandywer%2Fjquery-dim-background/lists"}