Support arbitrary permalink attributes

[oliverjam]

As discussed in #62, it would be nice to give the user the ability to set extra HTML attributes on the permalink anchor.

• Adds a permalinkAttrs object to opts that sets all key/value pairs at attributes
• Tests
• Docs

[oliverjam]

@nagaozen not sure if you saw this, but what do you think?

[nagaozen]

I'm not sure if this is the right approach to the problem. Could you imagine another use case for this option? Otherwise we could just observe for permalink href and inject aria attributes automatically

[oliverjam]

There are lots of HTML and ARIA attributes that devs might want to set on the link. For example: tabindex or title. This library currently only allows setting the className, which isn't as flexible.

Injecting the aria-label automatically only works if the dev doesn't want to customise it to have more or less information than we decide. Some people might be happy with the label just being "permalink", whereas others might want to use the text content of the heading, or put custom text in there to describe what exactly the permalink is for.

[nagaozen]

So, I believe that we are looking for a function which also receives (slug, state) and returns an object used to populate custom attributes to the anchor... could you fix the PR to receive a function instead an object? This way the behaviour is far more dynamic and the option becomes more useful.

[oliverjam]

I agree, that's a great idea, I'll add it asap.

Would you just support a function, or could we fallback to an object for the simple case where a dev just wants to set (for example) a static label?

[nagaozen]

I believe just a function is better, no need to overload the option. We must try to keep it simple and coherent with the other options

[nagaozen]

PR is ready to merge