Skip to main content

Model and front end library for choosing and integrating social media share widgets.

Project description

django-share-me-share-me
=======================

Model and front end library for choosing and integrating social media share widgets, similar to AddThis.


#Install

```
pip install django-share-me-share-me
```


#CMS Usage:

To make social settings administerable, include social_share_settings and rake the database:
```python
#settings.py


INSTALLED_APPS = (
...
'share_me_share_me',
...
)
```

```
> python manage.py schemamigration share_me_share_me --initial
> python manage.py migrate share_me_share_me
```

To make track social shares:

```python
#urls.py
(r'^', include('share_me_share_me.urls')),
```



#Template Usage:
To output share icons based on the settings from the cms, use the
"social_share_settings_tags" template tags. In this case I'm using
"Font Awesome" to render the icons.
```
#social-share-partial.html
{% load share_me_share_me_tags %}

{% get_social_share_links as social_links %}

{% if social_links|length > 0 %}
<ul class="social sticky">
{% for link in social_links %}
{% get_social_share_link link object.get_absolute_url object.title as link_url %}
<li>
<a href="{{ link_url }}" target="_blank">
<i class="fa fa-{{link.font_awesome_class}}"></i>
</a>
</li>
{% endfor %}
</ul>
{% endif %}
```


#Sticky Usage
For sticky behavior, include or compile in the styles and javscript.

See screencast of sticky widget in action: http://screencast.com/t/Gm8Sah4IMQ
```html
#base-template.html
<!-- Include Font Awesome for easier social icons -->
<link href="//maxcdn.bootstrapcdn.com/font-awesome/4.2.0/css/font-awesome.min.css" rel="stylesheet" />

<!-- Include js plugin and css or compile into your source js -->
<link rel="stylesheet" href="{% static 'ccl/sticky.min.css' %}"/>
<script src="{% static 'js/sticky.jqueryplugin.js'%}"></script>
<script>
$(".sticky").sticky({
topSelector : "#main",
bottomSelector : "#footer",
fixedMargin : 160,
topMargin : 0,
bottomMargin : 0
});
</script>
```
*topSelector* is the selector for the item the sticky widget should top-align with.

*bottomSelector* is the selector for the item the sticky widget should not go below.

*topMargin* refers to the top margin the sticky item will have when aligned to the top selector item

![topMargin example](/../master/docs/screenshots/top_margin.png?raw=true "topMargin example")

*fixedMargin* refers to the top margin the sticky item will have when the screen has scrolled past the top selector item

![fixedMargin example](/../master/docs/screenshots/fixed_margin.png?raw=true "fixedMargin example")

*bottomMargin* refers to the bottom margin the sticky item will have when aligned to the bottom selector item

![bottomMargin example](/../master/docs/screenshots/bottom_margin.png?raw=true "bottomMargin example")

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-share-me-share-me-1.2.tar.gz (11.2 kB view details)

Uploaded Source

File details

Details for the file django-share-me-share-me-1.2.tar.gz.

File metadata

File hashes

Hashes for django-share-me-share-me-1.2.tar.gz
Algorithm Hash digest
SHA256 3a89498905de7519fb1069f0582b29e92c6cb4b701468db14ddc57d8276d8e51
MD5 271fe82fcc9c20cc2403f11e76434bb2
BLAKE2b-256 dccb19a8941dd1c68f994d1bd08004891dd5e57dc424fac364b48765d6745e16

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page