Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement forceWidth and forceHeight options #94

Merged
merged 2 commits into from
Nov 26, 2017
Merged

Implement forceWidth and forceHeight options #94

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0783e8b
Implement forceWidth and forceHeight options
peterhry Nov 26, 2017
9b48c9c
Move function that gets letter rotations to util
peterhry Nov 26, 2017
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
2 changes: 1 addition & 1 deletion README.hbs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A JavaScript library that lets you curve type on the web.

Demo: <http://circletype.labwire.ca>
Demo: <https://circletype.labwire.ca>

## Installation

Expand Down
96 changes: 93 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

A JavaScript library that lets you curve type on the web.

Demo: <http://circletype.labwire.ca>
Demo: <https://circletype.labwire.ca>

## Installation

Expand Down Expand Up @@ -39,6 +39,10 @@ A CircleType instance creates a circular text element.
* [.radius()](#CircleType+radius) ⇒ <code>number</code>
* [.dir(value)](#CircleType+dir) ⇒ [<code>CircleType</code>](#CircleType)
* [.dir()](#CircleType+dir) ⇒ <code>number</code>
* [.forceWidth(value)](#CircleType+forceWidth) ⇒ [<code>CircleType</code>](#CircleType)
* [.forceWidth()](#CircleType+forceWidth) ⇒ <code>boolean</code>
* [.forceHeight(value)](#CircleType+forceHeight) ⇒ [<code>CircleType</code>](#CircleType)
* [.forceHeight()](#CircleType+forceHeight) ⇒ <code>boolean</code>
* [.refresh()](#CircleType+refresh) ⇒ [<code>CircleType</code>](#CircleType)
* [.destroy()](#CircleType+destroy) ⇒ [<code>CircleType</code>](#CircleType)

Expand Down Expand Up @@ -92,7 +96,7 @@ for the text to form a complete circle.
const circleType = new CircleType(document.getElementById('myElement'));

circleType.radius();
// > 150
//=> 150
```
<a name="CircleType+dir"></a>

Expand Down Expand Up @@ -128,7 +132,93 @@ Gets the text direction. `1` is clockwise, `-1` is counter-clockwise.
const circleType = new CircleType(document.getElementById('myElement'));

circleType.dir();
// > 1 (clockwise)
//=> 1 (clockwise)
```
<a name="CircleType+forceWidth"></a>

### circleType.forceWidth(value) ⇒ [<code>CircleType</code>](#CircleType)
Sets the `forceWidth` option. If `true` the width of the arc is calculated
and applied to the element as an inline style.

**Kind**: instance method of [<code>CircleType</code>](#CircleType)
**Returns**: [<code>CircleType</code>](#CircleType) - The current instance.

| Param | Type | Description |
| --- | --- | --- |
| value | <code>boolean</code> | `true` if the width should be set |

**Example**
```js
const circleType = new CircleType(document.getElementById('myElement'));

circleType.radius(384);

console.log(circleType.container);
//=> <div style="position: relative; height: 3.18275em;">...</div>

// Enable the force width option
circleType.forceWidth(true);

console.log(circleType.container);
//=> <div style="position: relative; height: 3.18275em; width: 12.7473em;">...</div>
```
<a name="CircleType+forceWidth"></a>

### circleType.forceWidth() ⇒ <code>boolean</code>
Gets the `forceWidth` option. If `true` the width of the arc is calculated
and applied to the element as an inline style. Defaults to `false`.

**Kind**: instance method of [<code>CircleType</code>](#CircleType)
**Returns**: <code>boolean</code> - The current `forceWidth` value
**Example**
```js
const circleType = new CircleType(document.getElementById('myElement'));

circleType.forceWidth();
//=> false
```
<a name="CircleType+forceHeight"></a>

### circleType.forceHeight(value) ⇒ [<code>CircleType</code>](#CircleType)
Sets the `forceHeight` option. If `true` the height of the arc is calculated
and applied to the element as an inline style.

**Kind**: instance method of [<code>CircleType</code>](#CircleType)
**Returns**: [<code>CircleType</code>](#CircleType) - The current instance.

| Param | Type | Description |
| --- | --- | --- |
| value | <code>boolean</code> | `true` if the height should be set |

**Example**
```js
const circleType = new CircleType(document.getElementById('myElement'));

circleType.radius(384);

console.log(circleType.container);
//=> <div style="position: relative; height: 3.18275em;">...</div>

// Disable the force height option
circleType.forceHeight(false);

console.log(circleType.container);
//=> <div style="position: relative;">...</div>
```
<a name="CircleType+forceHeight"></a>

### circleType.forceHeight() ⇒ <code>boolean</code>
Gets the `forceHeight` option. If `true` the height of the arc is calculated
and applied to the element as an inline style. Defaults to `true`.

**Kind**: instance method of [<code>CircleType</code>](#CircleType)
**Returns**: <code>boolean</code> - The current `forceHeight` value
**Example**
```js
const circleType = new CircleType(document.getElementById('myElement'));

circleType.forceHeight();
//=> true
```
<a name="CircleType+refresh"></a>

Expand Down
3 changes: 2 additions & 1 deletion assets/stylesheets/screen.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,9 @@ footer {

.demo {
color: #ff3300;
display:flex;
justify-content: center;
margin: 0;
text-align: center;
}

/**
Expand Down
4 changes: 2 additions & 2 deletions dist/circletype.min.js
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "circletype",
"version": "2.1.0",
"version": "2.2.0",
"description": "A JavaScript library that lets you curve type on the web.",
"main": "dist/circletype.min.js",
"files": [
Expand All @@ -10,11 +10,11 @@
"scripts": {
"dev": "webpack-dev-server --open",
"start": "eslint src && npm t && npm run docs && webpack -p",
"test": "jest src --notify && docker run -w /usr/data -v \"$PWD\":/usr/data tenjaa/java-chrome-nodejs npm run backstop-test",
"test": "jest src --notify && webpack -p && docker run -w /usr/data -v \"$PWD\":/usr/data tenjaa/java-chrome-nodejs npm run backstop-test",
"reference": "docker run -w /usr/data -v \"$PWD\":/usr/data tenjaa/java-chrome-nodejs npm run backstop-reference",
"backstop-test": "backstop test",
"backstop-reference": "backstop reference",
"docs": "jsdoc2md --template README.hbs --files src/class.js > README.md"
"docs": "jsdoc2md --heading-depth 2 --template README.hbs --files src/class.js > README.md"
},
"keywords": [
"circletype",
Expand Down
Loading