v0.1.0 of The URL Params Plugin #14

tommydarko · 2016-07-14T19:21:13Z

For your consideration. Working examples of plugin can be seen here:

With an embedded experience: http://demo.ceros.com/examples/toms-tests/state-of-the-layer/#animal=cow
With a stand alone experience : http://view.ceros.com/labs-tom-barretts-tests/example-2-1/p/1#animal=chicken

cerosteam · 2016-07-15T19:29:21Z

README.md

+
+## The State of the Layer Plugin
+
+Allows people using the Ceros Studio's SDK pallet to tag components to enable them to both control, and be controlled by, parameters in the Experience's URL. It can be used to remember user's actions between pages or to trigger actions like showing layers or jumping to anchor points when the Experience is opened by the user.


Can you give an example of what it is to "remember actions between pages"

Sorry to just barge into this code review but I'd really like a concrete use case not accomplishable with the current functionality of Ceros and the SDK that this plugin enables. I am very confused about what this plugin does.

@addelong i thought all plugins are built up on top of the SDK and functionality of ceros so no plugins accomplish more than ceros and the sdk i thought

I mean like, I am confused about what this is actually doing, and is there a different way of accomplishing what we want that's already built in to Ceros.

Just looking for a use case to help me understand.

Think of it in terms of a single page experience with 5 tabs. With normal Ceros, if the experience is refreshed, it goes back to the original tab open. With plugin improved Ceros, when you click a tab it updates the URL. Now when you refresh, the layers are set so that the tab you clicked is open by default.

its essentially providing a framework for using the # as a means to click hotspots across page requests.

basically I create a hotspot that does some thing. tag it with "now-kiss=true".

then i can go to <viewurl>#now-kiss=true and that hotspot will get clicked.

tom has provided a way to use set-state to append the payload of a component to the url to give some interaction that will i suppose allow for a deep link to a non page load state of an experience etc etc

Tom might have to explain where the need comes from

aaaaahhhhhh, I see.

I would like to vote for a name change for this plugin, might I suggest #doThings

SamJacobs · 2016-07-15T19:40:50Z

I believe you also need to make a couple changes to the gruntfile in the root of the repo @tommydarko

SamJacobs · 2016-07-15T19:41:40Z

Search for 'eloqua' and you can see a bunch of places that need sections added for new plugins and a string in a list of plugins

SamJacobs · 2016-07-15T19:42:34Z

src/state-of-the-layer/state-of-the-layer.js

+    "use strict";
+
+    /**
+     * Class to mange state represented in the URL


SamJacobs · 2016-07-15T20:43:13Z

@tommydarko done with first pass through ->
I think it would be super helpful if chunks of logic were extracted and variables renamed and mapped to the man things the plugin is doing as you explained it to me which i found super helpful!

there are tagged/named components that trigger some action configured in the studio
Objects with payload will have the payload added to the url
on player page change we parse the hash and then trigger the action in step 1

Note: changing the hash currently has no effect on the current page, it is only parsed the next time a page change event is emitted.

tommydarko · 2016-07-19T22:40:02Z

Hey @SamJacobs: Please could you take another look through? Thank you! :-)

SamJacobs · 2016-07-20T15:36:34Z

README.md

-3. Use the SDK Inspector Pallet to tag the hot spot with a name and a value to be used as the URL parameter. For example if you wanted to show the second slide in a slide show, you could tag it `slide=2` - this would allow you to trigger this action by adding `#side=2` to the end of the URL.
-
-4. If you would like to be able to update the URL based on user's actions in the Studio, tag components with `set-state` and set the pay load to the name/value pair you would like to add to the URL.
+3. Use the SDK Inspector Pallet to tag the hot spot with a name and a value to be used as the URL parameter. For example if you wanted to show the second slide in a slide show, you could tag it `slide=2` - this would allow you to trigger this action by adding `side=2` to the end of the URL, after a `#` symbol.


sorry the note on this was a typo in side=2

SamJacobs · 2016-07-20T15:57:03Z

@tommydarko i made some more notes, ready for you

tommydarko · 2016-07-20T20:27:39Z

@SamJacobs: please can you take another pass? Hopefully for the last time! :-)

SamJacobs · 2016-07-20T22:06:12Z

src/url-params/url-params.js

+        setParameterValueForKey: function(theKey, theValue) {
+
+            // If we have this key already
+            if (this.hasKey(theKey)) {


ahh sorry tom, one thing i did notice is that we loop through the state for has key, then loop through again to find the right one.

its probably not a huge deal because the size of state is very small, but i dont know if you need the haskey method. essentially you loop through them all, if the key of the current index is the key you want to set then set it and return, otherwise if you get all the way through the looop without returning you make a new object and push it onto state.

just a little optimization, really not necessary, ill give a +1 without it, but let me know if you want to make this change and i'll re +1

SamJacobs · 2016-07-20T22:07:32Z

code 👍

one little note but feel free to ignore it, i dont think it's essential

SamJacobs · 2016-07-20T22:08:16Z

oh also change the name of the issue/pull request to url params, the branch can stay the same prolly

qualityshepherd · 2016-08-15T18:10:25Z

Tom/Sam does this need testing?

grahamedaley · 2016-09-13T15:27:18Z

@tommydarko @SamJacobs does this need testing?

SamJacobs · 2016-09-13T15:33:00Z

this is tom's PR, i just reviewed it

brianpabent · 2016-09-29T20:47:58Z

Is this one that @tommydarko can release through his own QA process? Perhaps it is already released?

grahamedaley · 2016-09-30T15:54:27Z

@tommydarko does this require QA to test? if so this could be something you could pick up @qualityshepherd ?

danwashable · 2016-09-30T15:58:39Z

In response to @brianpabent's question, this does not need to go through our process. @tommydarko can move this through his own process. We don't need to worry about it.

v0.1.0 of The State of the Layer Plugin

9f1f70c

tommydarko added in progress review and removed in progress labels Jul 14, 2016

SamJacobs self-assigned this Jul 15, 2016

cerosteam reviewed Jul 15, 2016
View reviewed changes

SamJacobs reviewed Jul 15, 2016
View reviewed changes

src/state-of-the-layer/state-of-the-layer.js Outdated

"use strict";

/**

* Class to mange state represented in the URL

Copy link

Contributor

SamJacobs Jul 15, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mange!

SamJacobs assigned tommydarko and unassigned SamJacobs Jul 15, 2016

tommydarko added 4 commits July 19, 2016 17:16

code review changes

d62c1a7

renamed plugin

c34b33a

updated git file

4d3bfb9

updated words

951cba4

tommydarko changed the title ~~v0.1.0 of The State of the Layer Plugin~~ v0.1.0 of The URL Params Plugin (Previously known as The State of the Layer Plugin) Jul 19, 2016

tommydarko assigned SamJacobs Jul 19, 2016

SamJacobs changed the title ~~v0.1.0 of The URL Params Plugin (Previously known as The State of the Layer Plugin)~~ v0.1.0 of The State of the Layer Plugin Jul 20, 2016

SamJacobs reviewed Jul 20, 2016
View reviewed changes

SamJacobs removed their assignment Jul 20, 2016

tommydarko added 2 commits July 20, 2016 16:05

code review

85c485c

fixed issue from refactor

7ec2f6e

tommydarko assigned SamJacobs Jul 20, 2016

SamJacobs reviewed Jul 20, 2016
View reviewed changes

SamJacobs added testing and removed review labels Jul 21, 2016

SamJacobs unassigned tommydarko and SamJacobs Jul 21, 2016

tommydarko changed the title ~~v0.1.0 of The State of the Layer Plugin~~ v0.1.0 of The URL Params Plugin Jul 21, 2016

danwashable removed the testing label Nov 4, 2016


		## The State of the Layer Plugin

		Allows people using the Ceros Studio's SDK pallet to tag components to enable them to both control, and be controlled by, parameters in the Experience's URL. It can be used to remember user's actions between pages or to trigger actions like showing layers or jumping to anchor points when the Experience is opened by the user.

v0.1.0 of The URL Params Plugin #14

Are you sure you want to change the base?

v0.1.0 of The URL Params Plugin #14

Uh oh!

Conversation

tommydarko commented Jul 14, 2016 • edited by SamJacobs Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamJacobs Jul 15, 2016 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamJacobs commented Jul 15, 2016

Uh oh!

SamJacobs commented Jul 15, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamJacobs commented Jul 15, 2016

Uh oh!

tommydarko commented Jul 19, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamJacobs commented Jul 20, 2016

Uh oh!

tommydarko commented Jul 20, 2016

Uh oh!

Choose a reason for hiding this comment

Uh oh!

SamJacobs commented Jul 20, 2016

Uh oh!

SamJacobs commented Jul 20, 2016

Uh oh!

qualityshepherd commented Aug 15, 2016

Uh oh!

grahamedaley commented Sep 13, 2016

Uh oh!

SamJacobs commented Sep 13, 2016

Uh oh!

brianpabent commented Sep 29, 2016

Uh oh!

grahamedaley commented Sep 30, 2016

Uh oh!

danwashable commented Sep 30, 2016

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

9 participants

tommydarko commented Jul 14, 2016 •

edited by SamJacobs

Loading

SamJacobs Jul 15, 2016 •

edited

Loading